Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Adds a new comment to the specified document version.
Synopsis
- createComment :: Text -> Text -> Text -> CreateComment
- data CreateComment
- ccNotifyCollaborators :: Lens' CreateComment (Maybe Bool)
- ccAuthenticationToken :: Lens' CreateComment (Maybe Text)
- ccVisibility :: Lens' CreateComment (Maybe CommentVisibilityType)
- ccThreadId :: Lens' CreateComment (Maybe Text)
- ccParentId :: Lens' CreateComment (Maybe Text)
- ccDocumentId :: Lens' CreateComment Text
- ccVersionId :: Lens' CreateComment Text
- ccText :: Lens' CreateComment Text
- createCommentResponse :: Int -> CreateCommentResponse
- data CreateCommentResponse
- ccrsComment :: Lens' CreateCommentResponse (Maybe Comment)
- ccrsResponseStatus :: Lens' CreateCommentResponse Int
Creating a Request
Creates a value of CreateComment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccNotifyCollaborators
- Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.ccAuthenticationToken
- Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.ccVisibility
- 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.ccThreadId
- The ID of the root comment in the thread.ccParentId
- The ID of the parent comment.ccDocumentId
- The ID of the document.ccVersionId
- The ID of the document version.ccText
- The text of the comment.
data CreateComment Source #
See: createComment
smart constructor.
Instances
Request Lenses
ccNotifyCollaborators :: Lens' CreateComment (Maybe Bool) Source #
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
ccAuthenticationToken :: Lens' CreateComment (Maybe Text) Source #
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
ccVisibility :: 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.
ccThreadId :: Lens' CreateComment (Maybe Text) Source #
The ID of the root comment in the thread.
ccParentId :: Lens' CreateComment (Maybe Text) Source #
The ID of the parent comment.
ccDocumentId :: Lens' CreateComment Text Source #
The ID of the document.
ccVersionId :: Lens' CreateComment Text Source #
The ID of the document version.
Destructuring the Response
createCommentResponse Source #
Creates a value of CreateCommentResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccrsComment
- The comment that has been created.ccrsResponseStatus
- -- | The response status code.
data CreateCommentResponse Source #
See: createCommentResponse
smart constructor.
Instances
Response Lenses
ccrsComment :: Lens' CreateCommentResponse (Maybe Comment) Source #
The comment that has been created.
ccrsResponseStatus :: Lens' CreateCommentResponse Int Source #
- - | The response status code.