Home > @i2analyze/notebook-sdk > getEntryPointApi

getEntryPointApi() function

Retrieves the plug-in entry point API.

Signature:

export declare function getEntryPointApi(pluginId: string): Promise<IEntryPointApi>;

Introduced: version 1.0

Parameters

Parameter	Type	Description
pluginId	string	The plug-in identifier, which must match the identifier in the plug-in manifest file.

Returns:

Promise<IEntryPointApi>

A promise that resolves to the entry point API.

Exceptions

Error (through the promise) if the version of the SDK was incompatible with the deployed version of i2 Notebook, or if pluginId does not appear in the manifest.