Skip to content

CreateCommentRequest

Source code in docs_src/capo_workdocs/types/create_comment_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class CreateCommentRequest(TypedDict, closed=True):
    authentication_token: NotRequired[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ]
    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
    """<p>The ID of the document.</p>"""
    version_id: "capo_workdocs.types.document_version_id_type.DocumentVersionIdType"
    """<p>The ID of the document version.</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: "capo_workdocs.types.comment_text_type.CommentTextType"
    """<p>The text 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>"""
    notify_collaborators: "capo_workdocs.types.boolean_type.BooleanType"
    """<p>Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.</p>"""

authentication_token instance-attribute 

authentication_token: NotRequired[AuthenticationHeaderType]

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

document_id instance-attribute 

document_id: ResourceIdType

The ID of the document.

notify_collaborators instance-attribute 

notify_collaborators: BooleanType

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

parent_id instance-attribute 

parent_id: NotRequired[CommentIdType]

The ID of the parent comment.

text instance-attribute 

text: CommentTextType

The text of the comment.

thread_id instance-attribute 

thread_id: NotRequired[CommentIdType]

The ID of the root comment in the thread.

version_id instance-attribute 

version_id: DocumentVersionIdType

The ID of the document version.

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.