DS Server

Javascript: EmbeddedFile.getData Method

Method|Introduced in 29.0

Description

Gets the file's data as a base64 string.

Syntax

<void> EmbeddedFile.getData(<RequestStringCallback> 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 EmbeddedFile.getData in a practical document-editing workflow. It gets the file's data as a base64 string.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const embeddedFiles = mainText.embeddedFiles;
    embeddedFiles.getItem(function(embeddedFile) {
        if (!embeddedFile) {
            console.warn("No embedded file is available at the current input position.");
            return;
        }
    
        embeddedFile.getData(
            function(result) {
                console.log("get data result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);