getDialogApi() function

Retrieves the plug-in dialog API.

Signature:

export declare function getDialogApi(): Promise<dialog.IDialogApi>;

Returns:

Promise<dialog.IDialogApi>

A promise that resolves to the dialog API.

Introduced: version 1.4

Exceptions

Error (through the promise) if the version of the SDK was incompatible with the deployed version of i2 Notebook.