🔍 Code Extractor

class SiteContentProcessingInfoProvider

Maturity: 24

A SharePoint entity class that provides information about site content processing in the SharePoint Search Administration context.

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

Purpose

This class represents a SharePoint entity specifically designed to interact with the Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider service. It serves as a client-side representation for managing and retrieving information about how site content is processed in SharePoint search administration. The class inherits from Entity, providing standard entity operations while specializing in site content processing information.

Source Code

class SiteContentProcessingInfoProvider(Entity):
    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider"

Parameters

Name Type Default Kind
bases Entity -

Parameter Details

bases: Inherits from Entity class, which provides base functionality for SharePoint entity operations including property management, serialization, and client context handling

Return Value

Instantiation returns a SiteContentProcessingInfoProvider object that can be used to interact with SharePoint's site content processing information services. The entity_type_name property returns the string 'Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider' which identifies this entity type in SharePoint's client object model.

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 entity type

Returns: String value 'Microsoft.SharePoint.Client.Search.Administration.SiteContentProcessingInfoProvider' representing the SharePoint entity type identifier

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type identifier for site content processing information provider instance

Dependencies

  • office365

Required Imports

from office365.sharepoint.search.administration.site_content_processing_info_provider import SiteContentProcessingInfoProvider

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.search.administration.site_content_processing_info_provider import SiteContentProcessingInfoProvider

# Authenticate and create context
ctx = ClientContext('https://yourtenant.sharepoint.com/sites/yoursite').with_credentials(user_credentials)

# Instantiate the provider
provider = SiteContentProcessingInfoProvider(ctx)

# Access entity type name
entity_type = provider.entity_type_name
print(f"Entity Type: {entity_type}")

# The provider can be used with SharePoint's client object model operations
# Typically loaded and executed through the context
ctx.load(provider)
ctx.execute_query()

Best Practices

  • Always instantiate this class within a valid SharePoint ClientContext to ensure proper authentication and connection
  • Use the entity_type_name property to verify the correct entity type when working with SharePoint's client object model
  • This class should be loaded and executed through the ClientContext's load() and execute_query() methods for proper data retrieval
  • Ensure the authenticated user has appropriate permissions for Search Administration operations
  • This class is typically not instantiated directly but rather obtained through SharePoint's search administration API
  • The class follows SharePoint's entity pattern where properties are lazily loaded until execute_query() is called

Tags

sharepoint search administration content-processing entity office365 client-object-model site-content

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SiteMeTAInfoProvider 66.1% similar

    A SharePoint client class that provides access to site metadata information through Azure container SAS token retrieval.

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

  • class OrgNewsSiteInfo 64.5% similar

    A data class representing organizational news site information in 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/orgnewssite/info.py

  • class SiteProperties 63.7% similar

    Represents a SharePoint site collection's properties and provides methods to query and update site-level settings such as sharing capabilities, lock state, and customization permissions.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/sites/properties.py

  • class SiteScriptUpdateInfo 63.5% similar

    A class representing update information for SharePoint site scripts, inheriting from SiteScriptCreationInfo and providing the specific entity type name for update operations.

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

  • class GroupSiteInfo 62.8% similar

    A data class representing information about a SharePoint group site, including its URL, status, and related metadata.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/groups/site_info.py
← Back to Browse