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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a comment.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#comment_id ⇒ String

The ID of the comment.

Returns:

  • (String) —

    The ID of the comment.

#contributor ⇒ Types::User

The details of the user who made the comment.

Returns:

  • (Types::User) —

    The details of the user who made the comment.

#created_timestamp ⇒ Time

The time that the comment was created.

Returns:

  • (Time) —

    The time that the comment was created.

#parent_id ⇒ String

The ID of the parent comment.

Returns:

  • (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.

Returns:

  • (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.

Possible values:

  • DRAFT
  • PUBLISHED
  • DELETED

Returns:

  • (String) —

    The status of the comment.

#text ⇒ String

The text of the comment.

Returns:

  • (String) —

    The text of the comment.

#thread_id ⇒ String

The ID of the root comment in the thread.

Returns:

  • (String) —

    The ID of the root comment in the thread.

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

Possible values:

  • PUBLIC
  • PRIVATE

Returns:

  • (String) —

    The visibility of the comment.