You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::WorkDocs::Types::CreateCommentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkDocs::Types::CreateCommentRequest
- Defined in:
- (unknown)
Overview
When passing CreateCommentRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
authentication_token: "AuthenticationHeaderType",
document_id: "ResourceIdType", # required
version_id: "DocumentVersionIdType", # required
parent_id: "CommentIdType",
thread_id: "CommentIdType",
text: "CommentTextType", # required
visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
notify_collaborators: false,
}
Instance Attribute Summary collapse
-
#authentication_token ⇒ String
Amazon WorkDocs authentication token.
-
#document_id ⇒ String
The ID of the document.
-
#notify_collaborators ⇒ Boolean
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
-
#parent_id ⇒ String
The ID of the parent comment.
-
#text ⇒ String
The text of the comment.
-
#thread_id ⇒ String
The ID of the root comment in the thread.
-
#version_id ⇒ String
The ID of the document version.
-
#visibility ⇒ String
The visibility of the comment.
Instance Attribute Details
#authentication_token ⇒ String
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
#document_id ⇒ String
The ID of the document.
#notify_collaborators ⇒ Boolean
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
#parent_id ⇒ String
The ID of the parent comment.
#text ⇒ String
The text of the comment.
#thread_id ⇒ String
The ID of the root comment in the thread.
#version_id ⇒ String
The ID of the document version.
#visibility ⇒ String
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.
Possible values:
- PUBLIC
- PRIVATE