AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::WorkDocs::Model::CreateCommentRequest Class Reference

#include <CreateCommentRequest.h>

+ Inheritance diagram for Aws::WorkDocs::Model::CreateCommentRequest:

Public Member Functions

 CreateCommentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAuthenticationToken () const
 
bool AuthenticationTokenHasBeenSet () const
 
void SetAuthenticationToken (const Aws::String &value)
 
void SetAuthenticationToken (Aws::String &&value)
 
void SetAuthenticationToken (const char *value)
 
CreateCommentRequestWithAuthenticationToken (const Aws::String &value)
 
CreateCommentRequestWithAuthenticationToken (Aws::String &&value)
 
CreateCommentRequestWithAuthenticationToken (const char *value)
 
const Aws::StringGetDocumentId () const
 
bool DocumentIdHasBeenSet () const
 
void SetDocumentId (const Aws::String &value)
 
void SetDocumentId (Aws::String &&value)
 
void SetDocumentId (const char *value)
 
CreateCommentRequestWithDocumentId (const Aws::String &value)
 
CreateCommentRequestWithDocumentId (Aws::String &&value)
 
CreateCommentRequestWithDocumentId (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
CreateCommentRequestWithVersionId (const Aws::String &value)
 
CreateCommentRequestWithVersionId (Aws::String &&value)
 
CreateCommentRequestWithVersionId (const char *value)
 
const Aws::StringGetParentId () const
 
bool ParentIdHasBeenSet () const
 
void SetParentId (const Aws::String &value)
 
void SetParentId (Aws::String &&value)
 
void SetParentId (const char *value)
 
CreateCommentRequestWithParentId (const Aws::String &value)
 
CreateCommentRequestWithParentId (Aws::String &&value)
 
CreateCommentRequestWithParentId (const char *value)
 
const Aws::StringGetThreadId () const
 
bool ThreadIdHasBeenSet () const
 
void SetThreadId (const Aws::String &value)
 
void SetThreadId (Aws::String &&value)
 
void SetThreadId (const char *value)
 
CreateCommentRequestWithThreadId (const Aws::String &value)
 
CreateCommentRequestWithThreadId (Aws::String &&value)
 
CreateCommentRequestWithThreadId (const char *value)
 
const Aws::StringGetText () const
 
bool TextHasBeenSet () const
 
void SetText (const Aws::String &value)
 
void SetText (Aws::String &&value)
 
void SetText (const char *value)
 
CreateCommentRequestWithText (const Aws::String &value)
 
CreateCommentRequestWithText (Aws::String &&value)
 
CreateCommentRequestWithText (const char *value)
 
const CommentVisibilityTypeGetVisibility () const
 
bool VisibilityHasBeenSet () const
 
void SetVisibility (const CommentVisibilityType &value)
 
void SetVisibility (CommentVisibilityType &&value)
 
CreateCommentRequestWithVisibility (const CommentVisibilityType &value)
 
CreateCommentRequestWithVisibility (CommentVisibilityType &&value)
 
bool GetNotifyCollaborators () const
 
bool NotifyCollaboratorsHasBeenSet () const
 
void SetNotifyCollaborators (bool value)
 
CreateCommentRequestWithNotifyCollaborators (bool value)
 
- Public Member Functions inherited from Aws::WorkDocs::WorkDocsRequest
virtual ~WorkDocsRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file CreateCommentRequest.h.

Constructor & Destructor Documentation

◆ CreateCommentRequest()

Aws::WorkDocs::Model::CreateCommentRequest::CreateCommentRequest ( )

Member Function Documentation

◆ AuthenticationTokenHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::AuthenticationTokenHasBeenSet ( ) const
inline

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

Definition at line 48 of file CreateCommentRequest.h.

◆ DocumentIdHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::DocumentIdHasBeenSet ( ) const
inline

The ID of the document.

Definition at line 95 of file CreateCommentRequest.h.

◆ GetAuthenticationToken()

const Aws::String& Aws::WorkDocs::Model::CreateCommentRequest::GetAuthenticationToken ( ) const
inline

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

Definition at line 42 of file CreateCommentRequest.h.

◆ GetDocumentId()

const Aws::String& Aws::WorkDocs::Model::CreateCommentRequest::GetDocumentId ( ) const
inline

The ID of the document.

Definition at line 90 of file CreateCommentRequest.h.

◆ GetNotifyCollaborators()

bool Aws::WorkDocs::Model::CreateCommentRequest::GetNotifyCollaborators ( ) const
inline

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

Definition at line 345 of file CreateCommentRequest.h.

◆ GetParentId()

const Aws::String& Aws::WorkDocs::Model::CreateCommentRequest::GetParentId ( ) const
inline

The ID of the parent comment.

Definition at line 172 of file CreateCommentRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WorkDocs::Model::CreateCommentRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WorkDocs::WorkDocsRequest.

◆ GetServiceRequestName()

virtual const char* Aws::WorkDocs::Model::CreateCommentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file CreateCommentRequest.h.

◆ GetText()

const Aws::String& Aws::WorkDocs::Model::CreateCommentRequest::GetText ( ) const
inline

The text of the comment.

Definition at line 254 of file CreateCommentRequest.h.

◆ GetThreadId()

const Aws::String& Aws::WorkDocs::Model::CreateCommentRequest::GetThreadId ( ) const
inline

The ID of the root comment in the thread.

Definition at line 213 of file CreateCommentRequest.h.

◆ GetVersionId()

const Aws::String& Aws::WorkDocs::Model::CreateCommentRequest::GetVersionId ( ) const
inline

The ID of the document version.

Definition at line 131 of file CreateCommentRequest.h.

◆ GetVisibility()

const CommentVisibilityType& Aws::WorkDocs::Model::CreateCommentRequest::GetVisibility ( ) const
inline

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.

Definition at line 298 of file CreateCommentRequest.h.

◆ NotifyCollaboratorsHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::NotifyCollaboratorsHasBeenSet ( ) const
inline

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

Definition at line 351 of file CreateCommentRequest.h.

◆ ParentIdHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::ParentIdHasBeenSet ( ) const
inline

The ID of the parent comment.

Definition at line 177 of file CreateCommentRequest.h.

◆ SerializePayload()

Aws::String Aws::WorkDocs::Model::CreateCommentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthenticationToken() [1/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetAuthenticationToken ( const Aws::String value)
inline

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

Definition at line 54 of file CreateCommentRequest.h.

◆ SetAuthenticationToken() [2/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetAuthenticationToken ( Aws::String &&  value)
inline

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

Definition at line 60 of file CreateCommentRequest.h.

◆ SetAuthenticationToken() [3/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetAuthenticationToken ( const char *  value)
inline

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

Definition at line 66 of file CreateCommentRequest.h.

◆ SetDocumentId() [1/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetDocumentId ( const Aws::String value)
inline

The ID of the document.

Definition at line 100 of file CreateCommentRequest.h.

◆ SetDocumentId() [2/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetDocumentId ( Aws::String &&  value)
inline

The ID of the document.

Definition at line 105 of file CreateCommentRequest.h.

◆ SetDocumentId() [3/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetDocumentId ( const char *  value)
inline

The ID of the document.

Definition at line 110 of file CreateCommentRequest.h.

◆ SetNotifyCollaborators()

void Aws::WorkDocs::Model::CreateCommentRequest::SetNotifyCollaborators ( bool  value)
inline

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

Definition at line 357 of file CreateCommentRequest.h.

◆ SetParentId() [1/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetParentId ( const Aws::String value)
inline

The ID of the parent comment.

Definition at line 182 of file CreateCommentRequest.h.

◆ SetParentId() [2/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetParentId ( Aws::String &&  value)
inline

The ID of the parent comment.

Definition at line 187 of file CreateCommentRequest.h.

◆ SetParentId() [3/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetParentId ( const char *  value)
inline

The ID of the parent comment.

Definition at line 192 of file CreateCommentRequest.h.

◆ SetText() [1/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetText ( const Aws::String value)
inline

The text of the comment.

Definition at line 264 of file CreateCommentRequest.h.

◆ SetText() [2/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetText ( Aws::String &&  value)
inline

The text of the comment.

Definition at line 269 of file CreateCommentRequest.h.

◆ SetText() [3/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetText ( const char *  value)
inline

The text of the comment.

Definition at line 274 of file CreateCommentRequest.h.

◆ SetThreadId() [1/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetThreadId ( const Aws::String value)
inline

The ID of the root comment in the thread.

Definition at line 223 of file CreateCommentRequest.h.

◆ SetThreadId() [2/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetThreadId ( Aws::String &&  value)
inline

The ID of the root comment in the thread.

Definition at line 228 of file CreateCommentRequest.h.

◆ SetThreadId() [3/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetThreadId ( const char *  value)
inline

The ID of the root comment in the thread.

Definition at line 233 of file CreateCommentRequest.h.

◆ SetVersionId() [1/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetVersionId ( const Aws::String value)
inline

The ID of the document version.

Definition at line 141 of file CreateCommentRequest.h.

◆ SetVersionId() [2/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetVersionId ( Aws::String &&  value)
inline

The ID of the document version.

Definition at line 146 of file CreateCommentRequest.h.

◆ SetVersionId() [3/3]

void Aws::WorkDocs::Model::CreateCommentRequest::SetVersionId ( const char *  value)
inline

The ID of the document version.

Definition at line 151 of file CreateCommentRequest.h.

◆ SetVisibility() [1/2]

void Aws::WorkDocs::Model::CreateCommentRequest::SetVisibility ( const CommentVisibilityType value)
inline

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.

Definition at line 314 of file CreateCommentRequest.h.

◆ SetVisibility() [2/2]

void Aws::WorkDocs::Model::CreateCommentRequest::SetVisibility ( CommentVisibilityType &&  value)
inline

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.

Definition at line 322 of file CreateCommentRequest.h.

◆ TextHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::TextHasBeenSet ( ) const
inline

The text of the comment.

Definition at line 259 of file CreateCommentRequest.h.

◆ ThreadIdHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::ThreadIdHasBeenSet ( ) const
inline

The ID of the root comment in the thread.

Definition at line 218 of file CreateCommentRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::VersionIdHasBeenSet ( ) const
inline

The ID of the document version.

Definition at line 136 of file CreateCommentRequest.h.

◆ VisibilityHasBeenSet()

bool Aws::WorkDocs::Model::CreateCommentRequest::VisibilityHasBeenSet ( ) const
inline

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.

Definition at line 306 of file CreateCommentRequest.h.

◆ WithAuthenticationToken() [1/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithAuthenticationToken ( const Aws::String value)
inline

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

Definition at line 72 of file CreateCommentRequest.h.

◆ WithAuthenticationToken() [2/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithAuthenticationToken ( Aws::String &&  value)
inline

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

Definition at line 78 of file CreateCommentRequest.h.

◆ WithAuthenticationToken() [3/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithAuthenticationToken ( const char *  value)
inline

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

Definition at line 84 of file CreateCommentRequest.h.

◆ WithDocumentId() [1/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithDocumentId ( const Aws::String value)
inline

The ID of the document.

Definition at line 115 of file CreateCommentRequest.h.

◆ WithDocumentId() [2/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithDocumentId ( Aws::String &&  value)
inline

The ID of the document.

Definition at line 120 of file CreateCommentRequest.h.

◆ WithDocumentId() [3/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithDocumentId ( const char *  value)
inline

The ID of the document.

Definition at line 125 of file CreateCommentRequest.h.

◆ WithNotifyCollaborators()

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithNotifyCollaborators ( bool  value)
inline

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

Definition at line 363 of file CreateCommentRequest.h.

◆ WithParentId() [1/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithParentId ( const Aws::String value)
inline

The ID of the parent comment.

Definition at line 197 of file CreateCommentRequest.h.

◆ WithParentId() [2/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithParentId ( Aws::String &&  value)
inline

The ID of the parent comment.

Definition at line 202 of file CreateCommentRequest.h.

◆ WithParentId() [3/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithParentId ( const char *  value)
inline

The ID of the parent comment.

Definition at line 207 of file CreateCommentRequest.h.

◆ WithText() [1/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithText ( const Aws::String value)
inline

The text of the comment.

Definition at line 279 of file CreateCommentRequest.h.

◆ WithText() [2/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithText ( Aws::String &&  value)
inline

The text of the comment.

Definition at line 284 of file CreateCommentRequest.h.

◆ WithText() [3/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithText ( const char *  value)
inline

The text of the comment.

Definition at line 289 of file CreateCommentRequest.h.

◆ WithThreadId() [1/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithThreadId ( const Aws::String value)
inline

The ID of the root comment in the thread.

Definition at line 238 of file CreateCommentRequest.h.

◆ WithThreadId() [2/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithThreadId ( Aws::String &&  value)
inline

The ID of the root comment in the thread.

Definition at line 243 of file CreateCommentRequest.h.

◆ WithThreadId() [3/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithThreadId ( const char *  value)
inline

The ID of the root comment in the thread.

Definition at line 248 of file CreateCommentRequest.h.

◆ WithVersionId() [1/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithVersionId ( const Aws::String value)
inline

The ID of the document version.

Definition at line 156 of file CreateCommentRequest.h.

◆ WithVersionId() [2/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithVersionId ( Aws::String &&  value)
inline

The ID of the document version.

Definition at line 161 of file CreateCommentRequest.h.

◆ WithVersionId() [3/3]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithVersionId ( const char *  value)
inline

The ID of the document version.

Definition at line 166 of file CreateCommentRequest.h.

◆ WithVisibility() [1/2]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithVisibility ( const CommentVisibilityType value)
inline

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.

Definition at line 330 of file CreateCommentRequest.h.

◆ WithVisibility() [2/2]

CreateCommentRequest& Aws::WorkDocs::Model::CreateCommentRequest::WithVisibility ( CommentVisibilityType &&  value)
inline

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.

Definition at line 338 of file CreateCommentRequest.h.


The documentation for this class was generated from the following file: