You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkDocs::Types::CreateCommentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Note:

When making an API call, you may pass CreateCommentRequest data as a 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)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#document_idString

The ID of the document.

Returns:

  • (String)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#notify_collaboratorsBoolean

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

Returns:

  • (Boolean)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#parent_idString

The ID of the parent comment.

Returns:

  • (String)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#textString

The text of the comment.

Returns:

  • (String)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#thread_idString

The ID of the root comment in the thread.

Returns:

  • (String)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#version_idString

The ID of the document version.

Returns:

  • (String)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end

#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.

Returns:

  • (String)


324
325
326
327
328
329
330
331
332
333
334
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 324

class CreateCommentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :version_id,
  :parent_id,
  :thread_id,
  :text,
  :visibility,
  :notify_collaborators)
  include Aws::Structure
end