DS Server

Javascript: CommentedText.getCreationTime Method

Method|Introduced in 30.0

Description

Gets the date and time when the comment has been inserted as a Unix timestamp in milliseconds. The time is a Coordinated Universal Time (UTC).

Syntax

<void> CommentedText.getCreationTime(<RequestNumberCallback> 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.getCreationTime in a practical document-editing workflow. It gets the date and time when the comment has been inserted as a Unix timestamp in milliseconds. The time is a Coordinated Universal Time (UTC).

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.getCreationTime(
            function(result) {
                console.log("get creation time result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);