Amazonka.WorkDocs.Types.Comment

Documentation

data Comment

Describes a comment.

See: newComment smart constructor.

Constructors

Comment'

Fields

• contributor :: Maybe User

  The details of the user who made the comment.

• createdTimestamp :: Maybe POSIX

  The time that the comment was created.

• parentId :: Maybe Text

  The ID of the parent comment.

• recipientId :: Maybe Text

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

• status :: Maybe CommentStatusType

  The status of the comment.

• text :: Maybe (Sensitive Text)

  The text of the comment.

• threadId :: Maybe Text

  The ID of the root comment in the thread.

• visibility :: Maybe CommentVisibilityType

  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.

• commentId :: Text

  The ID of the comment.

Instances

FromJSON Comment

Defined in Amazonka.WorkDocs.Types.Comment

Methods

parseJSON :: Value -> Parser Comment

parseJSONList :: Value -> Parser [Comment]

Generic Comment

Defined in Amazonka.WorkDocs.Types.Comment

Associated Types

type Rep Comment :: Type -> Type

Methods

from :: Comment -> Rep Comment x

to :: Rep Comment x -> Comment

Show Comment

Defined in Amazonka.WorkDocs.Types.Comment

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

NFData Comment

Defined in Amazonka.WorkDocs.Types.Comment

Methods

rnf :: Comment -> ()

Eq Comment

Defined in Amazonka.WorkDocs.Types.Comment

Methods

(==) :: Comment -> Comment -> Bool

(/=) :: Comment -> Comment -> Bool

Hashable Comment

Defined in Amazonka.WorkDocs.Types.Comment

Methods

hashWithSalt :: Int -> Comment -> Int

hash :: Comment -> Int

type Rep Comment

Defined in Amazonka.WorkDocs.Types.Comment

type Rep Comment = D1 ('MetaData "Comment" "Amazonka.WorkDocs.Types.Comment" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "Comment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "contributor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :*: S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "recipientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommentStatusType)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "threadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommentVisibilityType)) :*: S1 ('MetaSel ('Just "commentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newComment

Arguments

:: Text

$sel:commentId:Comment'

-> Comment

Create a value of Comment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contributor:Comment', comment_contributor - The details of the user who made the comment.

Comment, comment_createdTimestamp - The time that the comment was created.

$sel:parentId:Comment', comment_parentId - The ID of the parent comment.

$sel:recipientId:Comment', comment_recipientId - If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

Comment, comment_status - The status of the comment.

$sel:text:Comment', comment_text - The text of the comment.

$sel:threadId:Comment', comment_threadId - The ID of the root comment in the thread.

$sel:visibility:Comment', comment_visibility - 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.

$sel:commentId:Comment', comment_commentId - The ID of the comment.

comment_contributor :: Lens' Comment (Maybe User)

The details of the user who made the comment.

comment_createdTimestamp :: Lens' Comment (Maybe UTCTime)

The time that the comment was created.

comment_parentId :: Lens' Comment (Maybe Text)

The ID of the parent comment.

comment_recipientId :: Lens' Comment (Maybe Text)

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

comment_status :: Lens' Comment (Maybe CommentStatusType)

The status of the comment.

comment_text :: Lens' Comment (Maybe Text)

The text of the comment.

comment_threadId :: Lens' Comment (Maybe Text)

The ID of the root comment in the thread.

comment_visibility :: Lens' Comment (Maybe CommentVisibilityType)

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.

comment_commentId :: Lens' Comment Text

The ID of the comment.