AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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:

Instance Attribute Summary collapse

Instance Attribute Details

#comment_idString

The ID of the comment.

Returns:

  • (String)

    The ID of the comment.

#contributorTypes::User

The details of the user who made the comment.

Returns:

  • (Types::User)

    The details of the user who made the comment.

#created_timestampTime

The time that the comment was created.

Returns:

  • (Time)

    The time that the comment was created.

#parent_idString

The ID of the parent comment.

Returns:

  • (String)

    The ID of the parent comment.

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

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

#statusString

The status of the comment.

Possible values:

  • DRAFT
  • PUBLISHED
  • DELETED

Returns:

  • (String)

    The status of the comment.

#textString

The text of the comment.

Returns:

  • (String)

    The text of the comment.

#thread_idString

The ID of the root comment in the thread.

Returns:

  • (String)

    The ID of the root comment in the thread.

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

Possible values:

  • PUBLIC
  • PRIVATE

Returns:

  • (String)

    The visibility of the comment.