DS Server

CommentCallbackData Object

Object|Introduced in 30.0

Description

The type of the response parameter of the AddCommentCallback callback function.

Syntax

{
   comment: <CommentedText>,
   addResult: <AddResult>
}

Examples

The following example demonstrates CommentCallbackData in a practical document-editing workflow. The type of the response parameter of the AddCommentCallback callback function.

function inspectCommentCallbackData(commentCallbackData) {
    console.log("comment:", commentCallbackData.comment);
    console.log("add result:", commentCallbackData.addResult);
}

Members

Properties

PropertyDescription
addResultIndicates whether the comment was added successfully.
commentThe added comment. Is null if no comment could be added.