🔍 Code Extractor

A data class representing custom search query results with layout templates and properties for Microsoft Office Server Search REST API.

Purpose

CustomResult is a client-side value object that encapsulates search query results with customizable display templates and metadata. It inherits from ClientValue and is designed to work with Microsoft Office Server Search REST API, allowing developers to specify how search results should be grouped, displayed, and titled. The class provides a structured way to handle search result customization including layout templates for both groups and individual items, along with a property bag for additional metadata.

Source Code

class CustomResult(ClientValue):
    """
    This contains a list of query results, all of which are of the type specified in TableType.
    """

    def __init__(
        self,
        group_template_id=None,
        item_template_id=None,
        result_title=None,
        properties=None,
    ):
        """
        :param str group_template_id: Specifies the identifier of the layout template that specifies how the results
            returned will be arranged.
        :param str item_template_id: Specifies the identifier of the layout template that specifies how the result
            item will be displayed.
        :param str result_title: Specifies the title associated with results for the transformed query by query rule
            action. MUST NOT be more than 64 characters in length.
        :param dict properties: Specifies a property bag of key value pairs.
        """
        self.GroupTemplateId = group_template_id
        self.ItemTemplateId = item_template_id
        self.Properties = properties
        self.ResultTitle = result_title

    @property
    def entity_type_name(self):
        return "Microsoft.Office.Server.Search.REST.CustomResult"

Parameters

Parameter Details

group_template_id: Optional string identifier specifying the layout template that determines how the collection of results will be arranged/grouped. This controls the visual organization of multiple search results. Defaults to None if not specified.

item_template_id: Optional string identifier specifying the layout template that determines how each individual result item will be displayed. This controls the visual presentation of a single search result. Defaults to None if not specified.

result_title: Optional string specifying the title associated with the transformed query results. This title is applied when query rule actions transform the query. Must not exceed 64 characters in length. Defaults to None if not specified.

properties: Optional dictionary (property bag) containing key-value pairs for additional metadata or configuration options associated with the search results. Allows for extensible custom properties. Defaults to None if not specified.

Return Value

Instantiation returns a CustomResult object with four instance attributes (GroupTemplateId, ItemTemplateId, Properties, ResultTitle) initialized from the constructor parameters. The entity_type_name property returns the string 'Microsoft.Office.Server.Search.REST.CustomResult' which identifies the type in the Microsoft Office Server Search REST API context.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.search.query.custom_result import CustomResult

# Create a custom result with all parameters
custom_result = CustomResult(
    group_template_id='group_template_001',
    item_template_id='item_template_001',
    result_title='Search Results for Documents',
    properties={'category': 'documents', 'priority': 'high'}
)

# Access attributes
print(custom_result.GroupTemplateId)  # 'group_template_001'
print(custom_result.ResultTitle)  # 'Search Results for Documents'
print(custom_result.entity_type_name)  # 'Microsoft.Office.Server.Search.REST.CustomResult'

# Create with minimal parameters
minimal_result = CustomResult(result_title='Quick Search')
print(minimal_result.ResultTitle)  # 'Quick Search'
print(minimal_result.GroupTemplateId)  # None

Best Practices

• Ensure result_title does not exceed 64 characters to comply with API constraints
• Use meaningful template IDs that correspond to actual layout templates configured in your SharePoint/Office 365 environment
• The properties dictionary should contain serializable key-value pairs suitable for REST API transmission
• This class is typically instantiated as part of search query configuration and should be used in conjunction with other Office 365 search API components
• The class is immutable after instantiation in typical usage - attributes are set via constructor and accessed directly
• When using with Office 365 SDK, ensure proper authentication context is established before using CustomResult objects in API calls
• The entity_type_name property is used internally by the Office 365 SDK for serialization and should not be modified

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class PromotedResultsOperationsResult 72.5% similar

  A data class representing the result of a REST API call to retrieve promoted search results from SharePoint/Office 365.

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

• class RefinementResults 71.5% similar

  A data class representing refinement results from a SharePoint search query, containing layout templates, refiners, and result metadata.

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

• class SpecialTermResult 70.9% similar

  A class representing a single row in the Table property of a SpecialTermResults Table from Microsoft Office Server Search REST API.

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

• class PersonalResultSuggestion 70.4% 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 SearchResponse 70.3% similar

  A data class that encapsulates search query results and the search terms used to generate those results, inheriting from ClientValue for Office 365 API integration.

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