🔍 Code Extractor

class TenantCustomQuerySuggestions

Maturity: 24

A client value class representing tenant-level custom query suggestions for SharePoint Search, inheriting from ClientValue base class.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/tenant_custom_query_suggestions.py
Lines:
4 - 7
Complexity:
simple

Purpose

This class serves as a data model for tenant custom query suggestions in SharePoint's search functionality. It provides a structured way to represent and interact with custom query suggestion settings at the tenant level. The class is part of the Office365 SharePoint Client Search Query API and is used to configure and manage custom search query suggestions that can be applied across an entire SharePoint tenant.

Source Code

class TenantCustomQuerySuggestions(ClientValue):
    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Client.Search.Query.TenantCustomQuerySuggestions"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: Inherits constructor from ClientValue base class. No explicit constructor parameters are defined in this class, so it uses the parent class's initialization logic.

Return Value

Instantiation returns a TenantCustomQuerySuggestions object that represents tenant-level custom query suggestions. The entity_type_name property returns a string identifying the SharePoint entity type: 'Microsoft.SharePoint.Client.Search.Query.TenantCustomQuerySuggestions'.

Class Interface

Methods

@property def entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by SharePoint's Client Object Model to identify this type of object

Returns: A string containing the SharePoint entity type identifier: 'Microsoft.SharePoint.Client.Search.Query.TenantCustomQuerySuggestions'

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type name for tenant custom query suggestions instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client.search.query.tenant_custom_query_suggestions import TenantCustomQuerySuggestions

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client.search.query.tenant_custom_query_suggestions import TenantCustomQuerySuggestions

# Instantiate the class
suggestions = TenantCustomQuerySuggestions()

# Access the entity type name
entity_type = suggestions.entity_type_name
print(entity_type)  # Output: Microsoft.SharePoint.Client.Search.Query.TenantCustomQuerySuggestions

# This class is typically used as part of SharePoint search query operations
# and would be populated with data from SharePoint API responses

Best Practices

  • This class is primarily a data container and should be used in conjunction with SharePoint search query APIs
  • The entity_type_name property is read-only and should not be modified
  • Instances of this class are typically created and populated by the Office365 SDK when interacting with SharePoint search APIs
  • This class inherits from ClientValue, which provides serialization/deserialization capabilities for SharePoint API communication
  • Do not instantiate this class directly for data manipulation; use it as part of the Office365 SDK's search query workflow
  • The class follows the SharePoint Client Object Model naming conventions and structure

Tags

sharepoint search query-suggestions tenant client-value office365 data-model search-configuration

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class QuerySuggestionQuery 83.3% similar

    A client value class representing a query suggestion query for SharePoint search operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/suggestion_results.py

  • class PopularTenantQuery 73.4% similar

    A client value class representing a popular tenant query in Microsoft SharePoint Search API, used to interact with SharePoint's search query functionality for popular tenant-level queries.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/popular_tenant_query.py

  • class QuerySuggestionResults 72.4% similar

    A container class for SharePoint search query suggestions, including people names, personal results, popular results, and query suggestions.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/suggestion_results.py

  • class PersonalResultSuggestion 70.3% similar

    A data class representing a personal search result suggestion from SharePoint Search, containing metadata about suggested results including title, URL, and best bet status.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/personal_result_suggestion.py

  • class SearchQuery 69.1% similar

    Represents a search query object that encapsulates search terms and optional query templates for SharePoint/Office365 search operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/search/query.py
← Back to Browse