Skip to content

Comment

Source code in docs_src/capo_workdocs/types/comment.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class Comment(TypedDict, closed=True):
    comment_id: "capo_workdocs.types.comment_id_type.CommentIdType"
    """<p>The ID of the comment.</p>"""
    parent_id: NotRequired["capo_workdocs.types.comment_id_type.CommentIdType"]
    """<p>The ID of the parent comment.</p>"""
    thread_id: NotRequired["capo_workdocs.types.comment_id_type.CommentIdType"]
    """<p>The ID of the root comment in the thread.</p>"""
    text: NotRequired["capo_workdocs.types.comment_text_type.CommentTextType"]
    """<p>The text of the comment.</p>"""
    contributor: NotRequired["capo_workdocs.types.user.User"]
    """<p>The details of the user who made the comment.</p>"""
    created_timestamp: NotRequired["capo_workdocs.types.timestamp_type.TimestampType"]
    """<p>The time that the comment was created.</p>"""
    status: NotRequired["capo_workdocs.types.comment_status_type.CommentStatusType"]
    """<p>The status of the comment.</p>"""
    visibility: NotRequired[
        "capo_workdocs.types.comment_visibility_type.CommentVisibilityType"
    ]
    """<p>The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.</p>"""
    recipient_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.</p>"""

comment_id instance-attribute 

comment_id: CommentIdType

The ID of the comment.

contributor instance-attribute 

contributor: NotRequired[User]

The details of the user who made the comment.

created_timestamp instance-attribute 

created_timestamp: NotRequired[TimestampType]

The time that the comment was created.

parent_id instance-attribute 

parent_id: NotRequired[CommentIdType]

The ID of the parent comment.

recipient_id instance-attribute 

recipient_id: NotRequired[IdType]

If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

status instance-attribute 

status: NotRequired[CommentStatusType]

The status of the comment.

text instance-attribute 

text: NotRequired[CommentTextType]

The text of the comment.

thread_id instance-attribute 

thread_id: NotRequired[CommentIdType]

The ID of the root comment in the thread.

visibility instance-attribute 

visibility: NotRequired[CommentVisibilityType]

The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.