Package software.amazon.awssdk.services.workdocs.model

Interface CreateCommentRequest.Builder

    • Method Detail

      • authenticationToken

        CreateCommentRequest.Builder authenticationToken​(String authenticationToken)

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

        Parameters:
        authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentId

        CreateCommentRequest.Builder documentId​(String documentId)

        The ID of the document.

        Parameters:
        documentId - The ID of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionId

        CreateCommentRequest.Builder versionId​(String versionId)

        The ID of the document version.

        Parameters:
        versionId - The ID of the document version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parentId

        CreateCommentRequest.Builder parentId​(String parentId)

        The ID of the parent comment.

        Parameters:
        parentId - The ID of the parent comment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • threadId

        CreateCommentRequest.Builder threadId​(String threadId)

        The ID of the root comment in the thread.

        Parameters:
        threadId - The ID of the root comment in the thread.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • text

        CreateCommentRequest.Builder text​(String text)

        The text of the comment.

        Parameters:
        text - The text of the comment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • visibility

        CreateCommentRequest.Builder visibility​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CommentVisibilityType, CommentVisibilityType

      • visibility

        CreateCommentRequest.Builder visibility​(CommentVisibilityType 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CommentVisibilityType, CommentVisibilityType

      • notifyCollaborators

        CreateCommentRequest.Builder notifyCollaborators​(Boolean notifyCollaborators)

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

        Parameters:
        notifyCollaborators - Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.