🔍 Code Extractor

RefinerEntry is a data class representing a single refinement entry in Microsoft Office Server Search REST API, containing a refinement name and its associated count.

Purpose

This class serves as a data transfer object (DTO) for SharePoint/Office 365 search refinement results. It encapsulates information about search refiners (facets), which are used to filter and narrow down search results. Each RefinerEntry represents one possible refinement option with its name and the count of items matching that refinement. This is commonly used in search UI to display filter options with result counts.

Source Code

class RefinerEntry(ClientValue):
    def __init__(self, refinement_count=None, refinement_name=None):
        """
        :param int refinement_count:
        :param str refinement_name:
        """
        self.RefinementCount = refinement_count
        self.RefinementName = refinement_name

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

Parameters

Parameter Details

refinement_count: An integer representing the number of search results that match this particular refinement. This count helps users understand how many items will be returned if they apply this refinement filter. Can be None if count is not available.

refinement_name: A string representing the name or value of the refinement option. This is the actual filter value that can be applied to narrow search results (e.g., 'PDF' for file type, '2023' for year). Can be None if name is not provided.

Return Value

Instantiation returns a RefinerEntry object that inherits from ClientValue. The object contains two instance attributes (RefinementCount and RefinementName) and provides an entity_type_name property that returns the Microsoft Office Server Search REST API type identifier string.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue

# Create a RefinerEntry for a file type refinement
refiner = RefinerEntry(
    refinement_count=42,
    refinement_name='PDF'
)

# Access the refinement data
print(f"Refinement: {refiner.RefinementName}")
print(f"Count: {refiner.RefinementCount}")
print(f"Entity Type: {refiner.entity_type_name}")

# Create with no initial values
empty_refiner = RefinerEntry()
empty_refiner.RefinementName = 'Word Document'
empty_refiner.RefinementCount = 15

Best Practices

• This class is primarily used as a data container and should not contain business logic
• Instances are typically created by the Office 365 SDK when parsing search results, rather than manually by developers
• The class inherits from ClientValue, which provides serialization/deserialization capabilities for Office 365 REST API communication
• RefinementCount and RefinementName are public attributes and can be modified after instantiation, though this is typically not necessary
• The entity_type_name property should not be overridden as it identifies the object type for the Microsoft Office Server Search REST API
• When using in search refinement scenarios, check if RefinementCount is None or 0 before displaying to users
• This class is immutable in practice - create new instances rather than modifying existing ones for thread safety

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Refiner 86.8% similar

  A Refiner class that represents a SharePoint search refiner containing a list of RefinerEntry objects, inheriting from ClientValue for Office 365 REST API integration.

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

• class RefinementResults 74.2% 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 SPResourceEntry 56.0% similar

  A data class representing a SharePoint resource entry with locale-specific values, inheriting from ClientValue for serialization support.

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

• class ReorderingRuleCollection 54.4% similar

  A SharePoint entity class that represents a collection of reordering rules for search results, inheriting from the Entity base class.

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

• class MessageEntry 54.3% similar

  A data class representing a message entry in Microsoft SharePoint, inheriting from ClientValue to provide serialization capabilities for SharePoint API interactions.

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