🔍 Code Extractor

Represents an event object that occurred on a Microsoft SharePoint SPFile, providing access to event metadata such as type, editor, and sharing information.

Purpose

This class encapsulates event data for file operations in Microsoft SharePoint. It provides read-only access to event properties including the event type, the user who initiated the event, and sharing-related information (shared by user and shared with users). It inherits from Entity, which likely provides base functionality for SharePoint entities. The class is designed to be instantiated with event data and queried for specific event attributes through property accessors.

Source Code

class FileVersionEvent(Entity):
    """Represents an event object happened on a Microsoft.SharePoint.SPFile."""

    @property
    def event_type(self):
        # type: () -> Optional[str]
        """Returns the type of the event."""
        return self.properties.get("EventType", None)

    @property
    def editor(self):
        # type: () -> Optional[str]
        """Returns the name of the user who initiated the event."""
        return self.properties.get("Editor", None)

    @property
    def shared_by_user(self):
        """Returns the shared by user Information in sharing action for change log."""
        return self.properties.get("SharedByUser", SharedWithUser())

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

Parameters

Parameter Details

__init__: The constructor is inherited from the Entity base class. Typically, Entity classes in the office365 library are instantiated with a context object and optionally a resource path. The exact parameters depend on the Entity base class implementation, but generally include: context (ClientContext) - the SharePoint client context for API operations, and resource_path (Optional[ResourcePath]) - the path to the SharePoint resource.

Return Value

Instantiation returns a FileVersionEvent object that represents a SharePoint file event. The class provides four property accessors: event_type returns Optional[str] indicating the type of event; editor returns Optional[str] with the name of the user who initiated the event; shared_by_user returns SharedWithUser object (or default empty instance) containing information about who shared the file; shared_with_users returns ClientValueCollection[SharedWithUser] containing an array of users the file was shared with.

Class Interface

Methods

Attributes

Dependencies

• office365
• typing

Required Imports

from office365.sharepoint.files.versions.event import FileVersionEvent
from office365.runtime.client_value_collection import ClientValueCollection
from office365.sharepoint.entity import Entity
from office365.sharepoint.sharing.shared_with_user import SharedWithUser

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.files.versions.event import FileVersionEvent

# Authenticate to SharePoint
ctx = ClientContext('https://yourtenant.sharepoint.com/sites/yoursite').with_credentials(
    UserCredential('username@domain.com', 'password')
)

# Typically obtained from a file's version history
file = ctx.web.get_file_by_server_relative_url('/sites/yoursite/documents/file.docx')
versions = file.versions
ctx.load(versions)
ctx.execute_query()

# Access event information (events would be part of version data)
for version in versions:
    # Assuming version has events property
    if hasattr(version, 'events'):
        for event in version.events:
            if isinstance(event, FileVersionEvent):
                print(f'Event Type: {event.event_type}')
                print(f'Editor: {event.editor}')
                print(f'Shared By: {event.shared_by_user}')
                print(f'Shared With: {len(event.shared_with_users)} users')
                for user in event.shared_with_users:
                    print(f'  - {user}')

Best Practices

• This class is read-only and designed for querying event data, not for creating or modifying events
• Always check if property values are None before using them, as event_type and editor return Optional[str]
• The shared_by_user property returns a default empty SharedWithUser object if not present, so check its properties rather than None
• The shared_with_users property returns a ClientValueCollection which can be iterated even if empty
• Instances are typically obtained from SharePoint API responses rather than manually instantiated
• The class inherits from Entity, so it may have additional methods and properties from the base class for property management and API operations
• Use within a proper SharePoint ClientContext to ensure authentication and API connectivity
• Properties are lazily evaluated from the internal properties dictionary, so ensure data is loaded via execute_query() before accessing

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class FileVersion 61.1% similar

  Represents a version of a File object.

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

• class LogFileInfo 58.7% similar

  LogFileInfo is a minimal entity class that represents log file information in SharePoint, inheriting all functionality from the Entity base class.

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

• class FileVersionCollection 58.5% similar

  Represents a collection of FileVersion.

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

• class AbstractFile 58.3% similar

  AbstractFile is a base class for SharePoint file operations, providing methods to read and write file content directly using the file's server-relative URL.

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

• class SPAuthEvent 57.3% similar

  SPAuthEvent is a SharePoint entity class representing authentication policy events in Microsoft SharePoint.

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