🔍 Code Extractor

class AnalyticsSignal

Maturity: 40

A class representing analytics signal data about an action performed by an actor on an item in SharePoint Search Analytics.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/analytics/signal.py
Lines:
4 - 9
Complexity:
simple

Purpose

AnalyticsSignal is a data container class that inherits from ClientValue and represents analytics signal information in Microsoft SharePoint Client Search Analytics. It encapsulates data about user actions or interactions with SharePoint items, providing a structured way to work with analytics events in the Office365 SharePoint API. The class is primarily used for tracking and reporting user behavior and engagement with SharePoint content.

Source Code

class AnalyticsSignal(ClientValue):
    """Contains data about an action performed by an actor on an item."""

    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Client.Search.Analytics.AnalyticsSignal"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: The constructor parameters are inherited from the ClientValue base class. Typically accepts keyword arguments that map to the properties of the analytics signal entity, such as action type, actor information, item details, and timestamp data.

Return Value

Instantiation returns an AnalyticsSignal object that represents a single analytics signal event. The entity_type_name property returns the string 'Microsoft.SharePoint.Client.Search.Analytics.AnalyticsSignal', which identifies the SharePoint entity type for serialization and API communication.

Class Interface

Methods

@property def entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name for the SharePoint Analytics Signal entity, used for serialization and API communication

Returns: A string containing 'Microsoft.SharePoint.Client.Search.Analytics.AnalyticsSignal', which identifies this entity type in the SharePoint API

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type identifier for analytics signals instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client.search.analytics.analytics_signal import AnalyticsSignal

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client.search.analytics.analytics_signal import AnalyticsSignal

# Instantiate an AnalyticsSignal object
signal = AnalyticsSignal()

# Access the entity type name
entity_type = signal.entity_type_name
print(entity_type)  # Output: Microsoft.SharePoint.Client.Search.Analytics.AnalyticsSignal

# Typically used within SharePoint context for analytics tracking
# Example: Sending analytics signal to SharePoint
# ctx = ClientContext(site_url).with_credentials(credentials)
# signal_data = AnalyticsSignal()
# # Set signal properties as needed
# ctx.execute_query()

Best Practices

  • This class is primarily a data container and should be instantiated with appropriate analytics signal data before being sent to SharePoint
  • Always use within a proper SharePoint ClientContext to ensure proper authentication and API communication
  • The entity_type_name property is used internally by the Office365 library for serialization and should not be modified
  • Inherit from this class if you need to extend analytics signal functionality with custom properties
  • Ensure proper permissions are configured in SharePoint before attempting to send or retrieve analytics signals
  • This class follows the ClientValue pattern used throughout the Office365-REST-Python-Client library for representing SharePoint entities

Tags

sharepoint analytics search office365 client-value data-container tracking user-behavior microsoft-graph

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class AnalyticsAction 84.5% similar

    A class representing an action in a Microsoft SharePoint Client Search Analytics Signal Object, inheriting from ClientValue.

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

  • class SignalStore 79.3% similar

    A class that provides methods for managing the SharePoint analytics signal store, inheriting from Entity base class.

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

  • class SPAnalyticsUsageService 63.0% similar

    A SharePoint analytics service class that provides an entry point for logging events through the SharePoint CSOM (Client-Side Object Model) Event REST service.

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

  • class AnalyticsUsageEntry 60.1% similar

    A SharePoint analytics class that provides static methods to log user or system events into the SharePoint analytics pipeline.

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

  • class AuditData 54.7% similar

    AuditData is a data class representing audit data in Microsoft SharePoint Tenant Administration, inheriting from ClientValue to provide serialization capabilities.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/audit/data.py
← Back to Browse