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

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

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

Overview

Describes a comment.

Instance Attribute Summary collapse

Instance Attribute Details

#comment_idString

The ID of the comment.

Returns:

  • (String)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#contributorTypes::User

The details of the user who made the comment.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#created_timestampTime

The time that the comment was created.

Returns:

  • (Time)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#parent_idString

The ID of the parent comment.

Returns:

  • (String)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#recipient_idString

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)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#statusString

The status of the comment.

Returns:

  • (String)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#textString

The text of the comment.

Returns:

  • (String)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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

#thread_idString

The ID of the root comment in the thread.

Returns:

  • (String)


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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


226
227
228
229
230
231
232
233
234
235
236
237
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 226

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