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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)

    Amazon WorkDocs authentication token.

#document_idString

The ID of the document.

Returns:

  • (String)

    The ID of the document.

#notify_collaboratorsBoolean

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

Returns:

  • (Boolean)

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

#parent_idString

The ID of the parent comment.

Returns:

  • (String)

    The ID of the parent comment.

#textString

The text of the comment.

Returns:

  • (String)

    The text of the comment.

#thread_idString

The ID of the root comment in the thread.

Returns:

  • (String)

    The ID of the root comment in the thread.

#version_idString

The ID of the document version.

Returns:

  • (String)

    The ID of the document version.

#visibilityString

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

Returns:

  • (String)

    The visibility of the comment.