AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateCommentInput

import "github.com/aws/aws-sdk-go/service/workdocs"

type CreateCommentInput struct { AuthenticationToken *string `location:"header" locationName:"Authentication" min:"1" type:"string" sensitive:"true"` DocumentId *string `location:"uri" locationName:"DocumentId" min:"1" type:"string" required:"true"` NotifyCollaborators *bool `type:"boolean"` ParentId *string `min:"1" type:"string"` Text *string `min:"1" type:"string" required:"true" sensitive:"true"` ThreadId *string `min:"1" type:"string"` VersionId *string `location:"uri" locationName:"VersionId" min:"1" type:"string" required:"true"` Visibility *string `type:"string" enum:"CommentVisibilityType"` }

AuthenticationToken

Type: *string

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

DocumentId

Type: *string

The ID of the document.

DocumentId is a required field

NotifyCollaborators

Type: *bool

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

ParentId

Type: *string

The ID of the parent comment.

Text

Type: *string

The text of the comment.

Text is a required field

ThreadId

Type: *string

The ID of the root comment in the thread.

VersionId

Type: *string

The ID of the document version.

VersionId is a required field

Visibility

Type: *string

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.

Method

GoString

func (s CreateCommentInput) GoString() string

GoString returns the string representation

SetAuthenticationToken

func (s *CreateCommentInput) SetAuthenticationToken(v string) *CreateCommentInput

SetAuthenticationToken sets the AuthenticationToken field's value.

SetDocumentId

func (s *CreateCommentInput) SetDocumentId(v string) *CreateCommentInput

SetDocumentId sets the DocumentId field's value.

SetNotifyCollaborators

func (s *CreateCommentInput) SetNotifyCollaborators(v bool) *CreateCommentInput

SetNotifyCollaborators sets the NotifyCollaborators field's value.

SetParentId

func (s *CreateCommentInput) SetParentId(v string) *CreateCommentInput

SetParentId sets the ParentId field's value.

SetText

func (s *CreateCommentInput) SetText(v string) *CreateCommentInput

SetText sets the Text field's value.

SetThreadId

func (s *CreateCommentInput) SetThreadId(v string) *CreateCommentInput

SetThreadId sets the ThreadId field's value.

SetVersionId

func (s *CreateCommentInput) SetVersionId(v string) *CreateCommentInput

SetVersionId sets the VersionId field's value.

SetVisibility

func (s *CreateCommentInput) SetVisibility(v string) *CreateCommentInput

SetVisibility sets the Visibility field's value.

String

func (s CreateCommentInput) String() string

String returns the string representation

Validate

func (s *CreateCommentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: