🔍 Code Extractor

class AuditData

Maturity: 24

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

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

Purpose

This class serves as a data transfer object (DTO) for SharePoint audit data within the Office365 REST API framework. It inherits from ClientValue to enable proper serialization/deserialization when communicating with SharePoint's Tenant Administration API. The class primarily provides metadata about its entity type for proper API interaction.

Source Code

class AuditData(ClientValue):
    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Administration.TenantAdmin.AuditData"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: Inherits constructor from ClientValue base class. The base class constructor typically accepts keyword arguments that map to the entity's properties as defined by the SharePoint API schema.

Return Value

Instantiation returns an AuditData object that can be used to represent audit data entities in SharePoint Tenant Administration operations. The entity_type_name property returns the string 'Microsoft.SharePoint.Administration.TenantAdmin.AuditData' which identifies this entity type in the SharePoint API.

Class Interface

Methods

@property entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by SharePoint's OData API to identify this entity type

Returns: String value 'Microsoft.SharePoint.Administration.TenantAdmin.AuditData' representing the entity type in the SharePoint API schema

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the OData entity type name for SharePoint Tenant Administration audit data instance

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.administration.tenant.audit_data import AuditData

Usage Example

from office365.sharepoint.administration.tenant.audit_data import AuditData
from office365.runtime.client_value import ClientValue

# Instantiate AuditData object
audit_data = AuditData()

# Access the entity type name (typically used internally by the API framework)
entity_type = audit_data.entity_type_name
print(entity_type)  # Output: Microsoft.SharePoint.Administration.TenantAdmin.AuditData

# The class is typically used as part of larger SharePoint API operations
# where it's instantiated and populated by the framework during API responses

Best Practices

  • This class is primarily used internally by the Office365 SDK framework for type identification and serialization
  • Typically instantiated by the SDK when deserializing API responses rather than manually by developers
  • The entity_type_name property should not be modified as it's used for API contract compliance
  • When extending this class, ensure any additional properties align with the SharePoint API schema
  • Use this class in conjunction with SharePoint ClientContext or other Office365 API client objects
  • The class inherits from ClientValue which provides serialization capabilities - leverage parent class methods for data manipulation

Tags

sharepoint audit tenant-administration data-transfer-object dto office365 client-value serialization rest-api

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class UnifiedAuditRecord 84.1% similar

    A data class representing a Unified Audit Record in Microsoft SharePoint's 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/unified_record.py

  • class Audit 69.0% similar

    A class that enables auditing of how SharePoint site collections, sites, lists, folders, and list items are accessed, changed, and used.

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

  • class AuditSearchRequestStatus 68.9% similar

    A client value class representing the status of an audit search request in SharePoint Tenant Administration.

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

  • class CollaborationInsightsOverview 67.6% similar

    A data class representing collaboration insights overview information for 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/collaboration/insights_overview.py

  • class CollaborationInsightsData 67.0% similar

    A data class representing collaboration insights data for SharePoint tenant administration, containing information about collaborative users and the last report date.

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