Skip to content

Create Comment

workdocs_create_comment R Documentation

Adds a new comment to the specified document version

Description

Adds a new comment to the specified document version.

Usage

workdocs_create_comment(AuthenticationToken, DocumentId, VersionId,
  ParentId, ThreadId, Text, Visibility, NotifyCollaborators)

Arguments

AuthenticationToken

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

DocumentId

[required] The ID of the document.

VersionId

[required] The ID of the document version.

ParentId

The ID of the parent comment.

ThreadId

The ID of the root comment in the thread.

Text

[required] The text of the 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.

NotifyCollaborators

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

Value

A list with the following syntax: 

list(
  Comment = list(
    CommentId = "string",
    ParentId = "string",
    ThreadId = "string",
    Text = "string",
    Contributor = list(
      Id = "string",
      Username = "string",
      EmailAddress = "string",
      GivenName = "string",
      Surname = "string",
      OrganizationId = "string",
      RootFolderId = "string",
      RecycleBinFolderId = "string",
      Status = "ACTIVE"|"INACTIVE"|"PENDING",
      Type = "USER"|"ADMIN"|"POWERUSER"|"MINIMALUSER"|"WORKSPACESUSER",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      TimeZoneId = "string",
      Locale = "en"|"fr"|"ko"|"de"|"es"|"ja"|"ru"|"zh_CN"|"zh_TW"|"pt_BR"|"default",
      Storage = list(
        StorageUtilizedInBytes = 123,
        StorageRule = list(
          StorageAllocatedInBytes = 123,
          StorageType = "UNLIMITED"|"QUOTA"
        )
      )
    ),
    CreatedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Status = "DRAFT"|"PUBLISHED"|"DELETED",
    Visibility = "PUBLIC"|"PRIVATE",
    RecipientId = "string"
  )
)

Request syntax

svc$create_comment(
  AuthenticationToken = "string",
  DocumentId = "string",
  VersionId = "string",
  ParentId = "string",
  ThreadId = "string",
  Text = "string",
  Visibility = "PUBLIC"|"PRIVATE",
  NotifyCollaborators = TRUE|FALSE
)