Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkDocs.Types.Comment

Description

Synopsis

data Comment = Comment' {
- status :: Maybe CommentStatusType
- text :: Maybe (Sensitive Text)
- visibility :: Maybe CommentVisibilityType
- threadId :: Maybe Text
- contributor :: Maybe User
- createdTimestamp :: Maybe POSIX
- recipientId :: Maybe Text
- parentId :: Maybe Text
- commentId :: Text
}
newComment :: Text -> Comment
comment_status :: Lens' Comment (Maybe CommentStatusType)
comment_text :: Lens' Comment (Maybe Text)
comment_visibility :: Lens' Comment (Maybe CommentVisibilityType)
comment_threadId :: Lens' Comment (Maybe Text)
comment_contributor :: Lens' Comment (Maybe User)
comment_createdTimestamp :: Lens' Comment (Maybe UTCTime)
comment_recipientId :: Lens' Comment (Maybe Text)
comment_parentId :: Lens' Comment (Maybe Text)
comment_commentId :: Lens' Comment Text

Documentation

data Comment Source #

Describes a comment.

See: newComment smart constructor.

Constructors

Comment'

Fields

status :: Maybe CommentStatusType
The status of the comment.
text :: Maybe (Sensitive Text)
The text of the comment.
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.
threadId :: Maybe Text
The ID of the root comment in the thread.
contributor :: Maybe User
The details of the user who made the comment.
createdTimestamp :: Maybe POSIX
The time that the comment was created.
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.
parentId :: Maybe Text
The ID of the parent comment.
commentId :: Text
The ID of the comment.

Instances

Instances details

Eq Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment Methods (==) :: Comment -> Comment -> Bool # (/=) :: Comment -> Comment -> Bool #
Show Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #
Generic Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment Associated Types type Rep Comment :: Type -> Type # Methods from :: Comment -> Rep Comment x # to :: Rep Comment x -> Comment #
NFData Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment Methods rnf :: Comment -> () #
Hashable Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment Methods hashWithSalt :: Int -> Comment -> Int # hash :: Comment -> Int #
FromJSON Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment Methods parseJSON :: Value -> Parser Comment # parseJSONList :: Value -> Parser [Comment] #
type Rep Comment Source #
Instance details Defined in Amazonka.WorkDocs.Types.Comment type Rep Comment = D1 ('MetaData "Comment" "Amazonka.WorkDocs.Types.Comment" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "Comment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommentStatusType)) :: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommentVisibilityType)) :: S1 ('MetaSel ('Just "threadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "contributor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :: S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "recipientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "commentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newComment Source #

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:status:Comment', comment_status - The status of the comment.

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

$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:threadId:Comment', comment_threadId - The ID of the root comment in the thread.

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

$sel:createdTimestamp:Comment', comment_createdTimestamp - The time that the comment was created.

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

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

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

comment_status :: Lens' Comment (Maybe CommentStatusType) Source #

The status of the comment.

comment_text :: Lens' Comment (Maybe Text) Source #

The text of the comment.

comment_visibility :: Lens' Comment (Maybe CommentVisibilityType) Source #

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_threadId :: Lens' Comment (Maybe Text) Source #

The ID of the root comment in the thread.

comment_contributor :: Lens' Comment (Maybe User) Source #

The details of the user who made the comment.

comment_createdTimestamp :: Lens' Comment (Maybe UTCTime) Source #

The time that the comment was created.

comment_recipientId :: Lens' Comment (Maybe Text) Source #

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

comment_parentId :: Lens' Comment (Maybe Text) Source #

The ID of the parent comment.

comment_commentId :: Lens' Comment Text Source #

The ID of the comment.