🔍 Code Extractor

A data class representing compliance information for SharePoint list items, including compliance tags and policy settings.

Purpose

This class encapsulates compliance-related metadata for SharePoint list items, storing information about compliance tags and various tag policy settings (event-based, hold, and record policies). It inherits from ClientValue, making it suitable for serialization and communication with SharePoint/Office 365 services. The class is used to track and manage compliance requirements and retention policies applied to list items in SharePoint environments.

Source Code

class ListItemComplianceInfo(ClientValue):
    def __init__(
        self,
        compliance_tag=None,
        tag_policy_event_based=None,
        tag_policy_hold=None,
        tag_policy_record=None,
    ):
        """
        :param str compliance_tag:
        :param bool tag_policy_event_based:
        :param bool tag_policy_hold:
        :param bool tag_policy_record:
        """
        self.ComplianceTag = compliance_tag
        self.TagPolicyEventBased = tag_policy_event_based
        self.TagPolicyHold = tag_policy_hold
        self.TagPolicyRecord = tag_policy_record

Parameters

Parameter Details

compliance_tag: A string identifier representing the compliance tag applied to the list item. This tag typically corresponds to a retention label or compliance policy name configured in SharePoint/Office 365. Can be None if no compliance tag is assigned.

tag_policy_event_based: A boolean flag indicating whether the compliance tag uses event-based retention. When True, the retention period starts based on a specific event (like document creation or modification) rather than a fixed date. Can be None if not applicable.

tag_policy_hold: A boolean flag indicating whether the compliance tag enforces a hold policy. When True, the list item is placed on hold and cannot be deleted or modified until the hold is released. Can be None if no hold policy is applied.

tag_policy_record: A boolean flag indicating whether the compliance tag marks the item as a record. When True, the item is treated as an official record with stricter retention and deletion policies. Can be None if the item is not designated as a record.

Return Value

Instantiation returns a ListItemComplianceInfo object with four instance attributes (ComplianceTag, TagPolicyEventBased, TagPolicyHold, TagPolicyRecord) set to the provided parameter values. The object inherits from ClientValue, which provides serialization capabilities for communication with Office 365 services.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.listitems.compliance_info import ListItemComplianceInfo

# Create compliance info for a list item with a retention label
compliance_info = ListItemComplianceInfo(
    compliance_tag="Financial Records - 7 Years",
    tag_policy_event_based=True,
    tag_policy_hold=False,
    tag_policy_record=True
)

# Access the compliance properties
print(f"Compliance Tag: {compliance_info.ComplianceTag}")
print(f"Event-based: {compliance_info.TagPolicyEventBased}")
print(f"On Hold: {compliance_info.TagPolicyHold}")
print(f"Is Record: {compliance_info.TagPolicyRecord}")

# Create compliance info with minimal settings
basic_compliance = ListItemComplianceInfo(compliance_tag="Standard Retention")

# Modify compliance settings after instantiation
compliance_info.TagPolicyHold = True

Best Practices

• Initialize all parameters explicitly when creating instances to ensure clarity about compliance settings
• Use None values for optional parameters rather than False to distinguish between 'not set' and 'explicitly disabled'
• This class is typically used as part of larger SharePoint list item operations and should be populated with data retrieved from or sent to SharePoint services
• The class inherits from ClientValue, which means it's designed for serialization - avoid adding complex objects or methods that can't be serialized
• Attribute names use PascalCase (ComplianceTag) following SharePoint API conventions, even though Python typically uses snake_case
• When integrating with SharePoint, ensure the compliance tags referenced exist in the SharePoint tenant's compliance center
• This is a data transfer object (DTO) - it holds data but doesn't contain business logic or validation
• All attributes are public and can be modified after instantiation, but changes should align with SharePoint compliance policies

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class ComplianceTagInfo 80.5% similar

  A data class representing compliance tag information for SharePoint compliance foundation models, storing metadata about regulatory and record-keeping requirements.

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

• class ComplianceTag 78.7% similar

  A data class representing a compliance tag in SharePoint's compliance policy system, inheriting from ClientValue to enable serialization for SharePoint API communication.

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

• class PendingReviewItemsStatistics 71.0% similar

  A data class representing statistics for pending review items in SharePoint's compliance policy system, tracking label information for items awaiting review.

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

• class ListItemCreationInformation 70.8% similar

  A data class that encapsulates the properties required to create a new list item in SharePoint, including file/folder specification, name, and location.

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

• class ListItemCreationInformationUsingPath 67.2% similar

  A data class that encapsulates the properties required to create a new list item in SharePoint, including its name, type, and folder location.

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