Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.CreateComment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a new comment to the specified document version.

Synopsis

data CreateComment = CreateComment' {
- authenticationToken :: Maybe (Sensitive Text)
- notifyCollaborators :: Maybe Bool
- parentId :: Maybe Text
- threadId :: Maybe Text
- visibility :: Maybe CommentVisibilityType
- documentId :: Text
- versionId :: Text
- text :: Sensitive Text
}
newCreateComment :: Text -> Text -> Text -> CreateComment
createComment_authenticationToken :: Lens' CreateComment (Maybe Text)
createComment_notifyCollaborators :: Lens' CreateComment (Maybe Bool)
createComment_parentId :: Lens' CreateComment (Maybe Text)
createComment_threadId :: Lens' CreateComment (Maybe Text)
createComment_visibility :: Lens' CreateComment (Maybe CommentVisibilityType)
createComment_documentId :: Lens' CreateComment Text
createComment_versionId :: Lens' CreateComment Text
createComment_text :: Lens' CreateComment Text
data CreateCommentResponse = CreateCommentResponse' {
- comment :: Maybe Comment
- httpStatus :: Int
}
newCreateCommentResponse :: Int -> CreateCommentResponse
createCommentResponse_comment :: Lens' CreateCommentResponse (Maybe Comment)
createCommentResponse_httpStatus :: Lens' CreateCommentResponse Int

Creating a Request

data CreateComment Source #

See: newCreateComment smart constructor.

Constructors

CreateComment'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
notifyCollaborators :: Maybe Bool
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
parentId :: Maybe Text
The ID of the parent 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.
documentId :: Text
The ID of the document.
versionId :: Text
The ID of the document version.
text :: Sensitive Text
The text of the comment.

Instances

Instances details

ToJSON CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods toJSON :: CreateComment -> Value # toEncoding :: CreateComment -> Encoding # toJSONList :: [CreateComment] -> Value # toEncodingList :: [CreateComment] -> Encoding #
ToHeaders CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods toHeaders :: CreateComment -> [Header] #
ToPath CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods toPath :: CreateComment -> ByteString #
ToQuery CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods toQuery :: CreateComment -> QueryString #
AWSRequest CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Associated Types type AWSResponse CreateComment # Methods request :: (Service -> Service) -> CreateComment -> Request CreateComment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateComment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateComment))) #
Generic CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Associated Types type Rep CreateComment :: Type -> Type # Methods from :: CreateComment -> Rep CreateComment x # to :: Rep CreateComment x -> CreateComment #
Show CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods showsPrec :: Int -> CreateComment -> ShowS # show :: CreateComment -> String # showList :: [CreateComment] -> ShowS #
NFData CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods rnf :: CreateComment -> () #
Eq CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods (==) :: CreateComment -> CreateComment -> Bool # (/=) :: CreateComment -> CreateComment -> Bool #
Hashable CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods hashWithSalt :: Int -> CreateComment -> Int # hash :: CreateComment -> Int #
type AWSResponse CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment type AWSResponse CreateComment = CreateCommentResponse
type Rep CreateComment Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment type Rep CreateComment = D1 ('MetaData "CreateComment" "Amazonka.WorkDocs.CreateComment" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "CreateComment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "notifyCollaborators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "threadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CommentVisibilityType)) :: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newCreateComment Source #

Arguments

:: Text	`$sel:documentId:CreateComment'`
-> Text	`CreateComment`
-> Text	`CreateComment`
-> CreateComment

Create a value of CreateComment 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:authenticationToken:CreateComment', createComment_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:notifyCollaborators:CreateComment', createComment_notifyCollaborators - Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

CreateComment, createComment_parentId - The ID of the parent comment.

CreateComment, createComment_threadId - The ID of the root comment in the thread.

CreateComment, createComment_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:documentId:CreateComment', createComment_documentId - The ID of the document.

CreateComment, createComment_versionId - The ID of the document version.

CreateComment, createComment_text - The text of the comment.

Request Lenses

createComment_authenticationToken :: Lens' CreateComment (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

createComment_notifyCollaborators :: Lens' CreateComment (Maybe Bool) Source #

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

createComment_parentId :: Lens' CreateComment (Maybe Text) Source #

The ID of the parent comment.

createComment_threadId :: Lens' CreateComment (Maybe Text) Source #

The ID of the root comment in the thread.

createComment_visibility :: Lens' CreateComment (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.

createComment_documentId :: Lens' CreateComment Text Source #

The ID of the document.

createComment_versionId :: Lens' CreateComment Text Source #

The ID of the document version.

createComment_text :: Lens' CreateComment Text Source #

The text of the comment.

Destructuring the Response

data CreateCommentResponse Source #

See: newCreateCommentResponse smart constructor.

Constructors

CreateCommentResponse'
Fields comment :: Maybe Comment The comment that has been created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Associated Types type Rep CreateCommentResponse :: Type -> Type # Methods from :: CreateCommentResponse -> Rep CreateCommentResponse x # to :: Rep CreateCommentResponse x -> CreateCommentResponse #
Show CreateCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods showsPrec :: Int -> CreateCommentResponse -> ShowS # show :: CreateCommentResponse -> String # showList :: [CreateCommentResponse] -> ShowS #
NFData CreateCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods rnf :: CreateCommentResponse -> () #
Eq CreateCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment Methods (==) :: CreateCommentResponse -> CreateCommentResponse -> Bool # (/=) :: CreateCommentResponse -> CreateCommentResponse -> Bool #
type Rep CreateCommentResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateComment type Rep CreateCommentResponse = D1 ('MetaData "CreateCommentResponse" "Amazonka.WorkDocs.CreateComment" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "CreateCommentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Comment)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCommentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCommentResponse'`
-> CreateCommentResponse

Create a value of CreateCommentResponse 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:comment:CreateCommentResponse', createCommentResponse_comment - The comment that has been created.

$sel:httpStatus:CreateCommentResponse', createCommentResponse_httpStatus - The response's http status code.

Response Lenses

createCommentResponse_comment :: Lens' CreateCommentResponse (Maybe Comment) Source #

The comment that has been created.

createCommentResponse_httpStatus :: Lens' CreateCommentResponse Int Source #

The response's http status code.