DS Server

Javascript: CommentedText.getReplies Method

Method|Introduced in 30.0

Description

Gets all replies of this comment or null if there are no replies.

Syntax

<void> CommentedText.getReplies(<RequestCommentsCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the property value.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates CommentedText.getReplies in a practical document-editing workflow. It gets all replies of this comment or null if there are no replies.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const comments = mainText.comments;
    comments.getItem(function(commentedText) {
        if (!commentedText) {
            console.warn("No commented text is available at the current input position.");
            return;
        }
    
        commentedText.getReplies(
            function(comments) {
                if (!comments) {
                    console.warn("No commented text was returned.");
                    return;
                }
                
                console.log("get replies result:", comments);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);