Class: Aws::WorkDocs::Types::Comment

Inherits:

Struct

• Object
• Struct
• Aws::WorkDocs::Types::Comment

Defined in:

gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb

Overview

Describes a comment.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:text]

Instance Attribute Summary

• #comment_id ⇒ String

  The ID of the comment.

• #contributor ⇒ Types::User

  The details of the user who made the comment.

• #created_timestamp ⇒ Time

  The time that the comment was created.

• #parent_id ⇒ String

  The ID of the parent comment.

• #recipient_id ⇒ String

  If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

• #status ⇒ String

  The status of the comment.

• #text ⇒ String

  The text of the comment.

• #thread_id ⇒ String

  The ID of the root comment in the thread.

• #visibility ⇒ String

  The visibility of the comment.

Instance Attribute Details

#comment_id ⇒ String

The ID of the comment.

Returns:

• (String)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#contributor ⇒ Types::User

The details of the user who made the comment.

Returns:

• (Types::User)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#created_timestamp ⇒ Time

The time that the comment was created.

Returns:

• (Time)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#parent_id ⇒ String

The ID of the parent comment.

Returns:

• (String)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#recipient_id ⇒ String

If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

Returns:

• (String)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#status ⇒ String

The status of the comment.

Returns:

• (String)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#text ⇒ String

The text of the comment.

Returns:

• (String)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end

#thread_id ⇒ String

The ID of the root comment in the thread.

Returns:

• (String)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [: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)

# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 213

class Comment < Struct.new(
  :comment_id,
  :parent_id,
  :thread_id,
  :text,
  :contributor,
  :created_timestamp,
  :status,
  :visibility,
  :recipient_id)
  SENSITIVE = [:text]
  include Aws::Structure
end