🔍 Code Extractor

A data class representing comment information in SharePoint, including the comment text and mentioned identities.

Purpose

CommentInformation is a client-side value object that encapsulates comment data for SharePoint comments. It stores the comment text and a collection of Identity objects representing users mentioned in the comment. This class inherits from ClientValue, making it suitable for serialization and transmission to SharePoint services. It's typically used when creating, updating, or retrieving comment data from SharePoint's commenting system.

Source Code

class CommentInformation(ClientValue):
    def __init__(self, text=None, mentions=None):
        """
        :param str text:
        :param list[Identity] mentions:
        """
        self.text = text
        self.mentions = ClientValueCollection(Identity, mentions)

    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Comments.CommentInformation"

Parameters

Parameter Details

text: The text content of the comment. This is a string containing the actual comment message. Can be None if not provided during initialization.

mentions: A list of Identity objects representing users who are mentioned/tagged in the comment. Each Identity object contains information about a mentioned user. Can be None or an empty list if no users are mentioned. This parameter is automatically wrapped in a ClientValueCollection for proper handling.

Return Value

Instantiation returns a CommentInformation object with initialized text and mentions attributes. The mentions attribute is always a ClientValueCollection of Identity objects, even if None or an empty list was passed. The entity_type_name property returns the string 'Microsoft.SharePoint.Comments.CommentInformation', which is used for type identification in SharePoint API interactions.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.runtime.client_value_collection import ClientValueCollection
from office365.sharepoint.comments.client.identity import Identity

Usage Example

from office365.sharepoint.comments.comment_information import CommentInformation
from office365.sharepoint.comments.client.identity import Identity

# Create a simple comment without mentions
comment = CommentInformation(text="This is a great document!")

# Create a comment with mentions
user1 = Identity()
user1.id = "user1@example.com"
user2 = Identity()
user2.id = "user2@example.com"

comment_with_mentions = CommentInformation(
    text="@user1 and @user2, please review this.",
    mentions=[user1, user2]
)

# Access comment properties
print(comment_with_mentions.text)
print(comment_with_mentions.entity_type_name)
print(len(comment_with_mentions.mentions))

Best Practices

• Always provide valid Identity objects when specifying mentions to ensure proper user tagging
• The mentions parameter is automatically converted to a ClientValueCollection, so you can pass a regular Python list
• This class is immutable after creation in typical usage - create new instances rather than modifying existing ones
• The entity_type_name property should not be modified as it's used by SharePoint for type identification
• When using with SharePoint API, ensure the text content follows SharePoint's comment length and formatting restrictions
• The class inherits from ClientValue, which means it can be serialized for API transmission automatically

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Identity_v1 77.8% similar

  Identity is a client value class representing a Microsoft SharePoint Comments identity entity, inheriting from ClientValue base class.

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

• class Comment 72.1% similar

  Represents a SharePoint comment entity with social interaction capabilities including liking/unliking and tracking users who liked the comment.

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

• class GetCommentFacet 68.9% similar

  A data class representing metadata facets for SharePoint activity comments, including information about assignees, participants, parent comments, and reply relationships.

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

• class CommentCollection 64.8% similar

  A collection class for managing SharePoint comments, providing operations to interact with multiple Comment entities as a group.

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

• class WebInfoCreationInformation 63.3% similar

  WebInfoCreationInformation is a data transfer object class that inherits from ClientValue, used to encapsulate information required for creating web instances in Office 365/SharePoint operations.

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