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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:authentication_token, :text]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_token ⇒ String

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

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

#document_id ⇒ String

The ID of the document.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

#notify_collaborators ⇒ Boolean

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

Returns:

  • (Boolean) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

#parent_id ⇒ String

The ID of the parent comment.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

#text ⇒ String

The text of the comment.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

#thread_id ⇒ String

The ID of the root comment in the thread.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

#version_id ⇒ String

The ID of the document version.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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

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

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aws-sdk-workdocs/types.rb', line 332

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