🔍 Code Extractor

class AnalyticsAction

Maturity: 40

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

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

Purpose

This class serves as a data model for analytics actions within the Microsoft SharePoint Client Search Analytics framework. It provides a structured representation of actions that can be tracked and analyzed in SharePoint search analytics. The class primarily defines the entity type name for proper serialization and communication with SharePoint services.

Source Code

class AnalyticsAction(ClientValue):
    """Represents the action in a Microsoft.SharePoint.Client.Search.Analytics.AnalyticsSignal Object."""

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

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 an AnalyticsAction object that represents a SharePoint analytics action. The entity_type_name property returns a string identifying the fully qualified type name in the SharePoint Client object model.

Class Interface

Methods

@property def entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name for this analytics action in the SharePoint Client object model

Returns: A string containing 'Microsoft.SharePoint.Client.Search.Analytics.AnalyticsAction' which identifies this object type in SharePoint services

Attributes

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

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.client_search.analytics.analytics_action import AnalyticsAction

# Instantiate an AnalyticsAction object
action = AnalyticsAction()

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

# This object would typically be used as part of a larger analytics signal
# in SharePoint search analytics tracking

Best Practices

  • This class is primarily a data model and should be instantiated when creating analytics signals for SharePoint search tracking
  • The entity_type_name property should not be overridden as it defines the correct type mapping for SharePoint services
  • Typically used in conjunction with other SharePoint analytics classes like AnalyticsSignal
  • Inherits serialization and deserialization behavior from ClientValue base class
  • Should be used within a properly authenticated SharePoint client context
  • This is a lightweight value object with no complex state management

Tags

sharepoint analytics search client-value data-model microsoft office365

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class AnalyticsSignal 84.5% similar

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

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

  • class SocialAttachmentAction 67.1% similar

    SocialAttachmentAction is a class that specifies user actions allowed for social attachment objects in Office 365, inheriting from ClientValue.

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

  • class SignalStore 66.5% 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 CustomActionElement 65.3% similar

    A class that represents a custom action element in the Office 365 API, inheriting from ClientValue to specify client-side component associations.

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

  • class CustomActionElementCollection 64.1% similar

    A collection class that manages a group of CustomActionElement objects, inheriting from ClientValue to provide SharePoint client-side value functionality.

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