🔍 Code Extractor

A class representing a change event on a SharePoint item, extending the base Change class with item-specific properties like activity type, content type, and sharing information.

Purpose

ChangeItem represents a change log entry for SharePoint items, providing access to metadata about what changed on an item including the type of activity performed, content type information, and details about sharing actions (who shared and with whom). It is used to track and query changes made to SharePoint list items or documents.

Source Code

class ChangeItem(Change):
    """A change on an item."""

    @property
    def activity_type(self):
        """
        Returns activity type defined in ChangeActivityType
        :rtype: str or None
        """
        return self.properties.get("ActivityType", None)

    @property
    def content_type_id(self):
        """
        Specifies an identifier for the content type
        """
        return self.properties.get("ContentTypeId", ContentTypeId())

    @property
    def shared_by_user(self):
        """Return the sharedBy User Information in sharing action for change log."""
        return self.properties.get("SharedByUser", SharedWithUser())

    @property
    def shared_with_users(self):
        """Returns the array of users that have been shared in sharing action for the change log."""
        return self.properties.get(
            "SharedWithUsers", ClientValueCollection(SharedWithUser)
        )

    def get_property(self, name, default_value=None):
        if default_value is None:
            property_mapping = {
                "ContentTypeId": self.content_type_id,
                "SharedByUser": self.shared_by_user,
                "SharedWithUsers": self.shared_with_users,
            }
            default_value = property_mapping.get(name, None)
        return super(ChangeItem, self).get_property(name, default_value)

Parameters

Name	Type	Default	Kind
bases	Change	-

Parameter Details

__init__: Inherits constructor from parent Change class. The exact parameters are not visible in this code but typically include change metadata from SharePoint's change log API.

Return Value

Instantiation returns a ChangeItem object that provides property-based access to change metadata. Properties return specific types: activity_type returns a string or None, content_type_id returns a ContentTypeId object, shared_by_user returns a SharedWithUser object, and shared_with_users returns a ClientValueCollection of SharedWithUser objects.

Class Interface

Methods

Attributes

Name	Type	Description	Scope
properties	dict	Inherited from parent Change class. Dictionary containing the raw property data from SharePoint's change log	instance

Dependencies

• office365.runtime.client_value_collection
• office365.sharepoint.changes.change
• office365.sharepoint.contenttypes.content_type_id
• office365.sharepoint.sharing.shared_with_user

Required Imports

from office365.runtime.client_value_collection import ClientValueCollection
from office365.sharepoint.changes.change import Change
from office365.sharepoint.contenttypes.content_type_id import ContentTypeId
from office365.sharepoint.sharing.shared_with_user import SharedWithUser

Usage Example

# Assuming you have a SharePoint context and change collection
from office365.sharepoint.changes.change_item import ChangeItem

# Typically obtained from a change query, not instantiated directly
# change_item = ctx.web.get_changes(query).execute_query()[0]

# Access change properties
activity = change_item.activity_type  # e.g., 'Add', 'Update', 'Delete'
content_type = change_item.content_type_id  # ContentTypeId object
shared_by = change_item.shared_by_user  # SharedWithUser object
shared_with = change_item.shared_with_users  # Collection of SharedWithUser objects

# Use get_property for flexible access
activity_via_method = change_item.get_property('ActivityType')
content_type_via_method = change_item.get_property('ContentTypeId')

Best Practices

• ChangeItem objects are typically obtained from SharePoint change queries, not instantiated directly by users
• Use property accessors (activity_type, content_type_id, etc.) for type-safe access to change metadata
• The get_property method provides a fallback mechanism with default values for missing properties
• Properties return default empty objects (ContentTypeId, SharedWithUser, ClientValueCollection) rather than None when data is missing
• This class is read-only and represents historical change data; it should not be modified
• Always check if activity_type is None before using it, as not all changes have an activity type
• The shared_by_user and shared_with_users properties are only populated for sharing-related activities

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Change 80.5% similar

  Represents a change event in a SharePoint installation, tracking modifications to items such as additions, updates, deletions, renames, and moves.

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

• class ChangeField 75.8% similar

  A class representing a change event on a SharePoint field, inheriting from the Change base class.

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

• class ChangeGroup 73.6% similar

  A class representing a change event on a SharePoint group, inheriting from the Change base class.

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

• class ChangeContentType 72.2% similar

  A class representing a change event on a SharePoint content type, inheriting from the Change base class.

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

• class ChangeFile 71.0% similar

  Represents a change event on a file that is not contained in a document library within SharePoint.

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

class ChangeItem(Change):
    """A change on an item."""

    @property
    def activity_type(self):
        """
        Returns activity type defined in ChangeActivityType
        :rtype: str or None
        """
        return self.properties.get("ActivityType", None)

    @property
    def content_type_id(self):
        """
        Specifies an identifier for the content type
        """
        return self.properties.get("ContentTypeId", ContentTypeId())

    @property
    def shared_by_user(self):
        """Return the sharedBy User Information in sharing action for change log."""
        return self.properties.get("SharedByUser", SharedWithUser())

    @property
    def shared_with_users(self):
        """Returns the array of users that have been shared in sharing action for the change log."""
        return self.properties.get(
            "SharedWithUsers", ClientValueCollection(SharedWithUser)
        )

    def get_property(self, name, default_value=None):
        if default_value is None:
            property_mapping = {
                "ContentTypeId": self.content_type_id,
                "SharedByUser": self.shared_by_user,
                "SharedWithUsers": self.shared_with_users,
            }
            default_value = property_mapping.get(name, None)
        return super(ChangeItem, self).get_property(name, default_value)