Home > @i2analyze/notebook-sdk > NotebookStatic > getEntryPointApi

NotebookStatic.getEntryPointApi() method

Retrieves the specified version of the plug-in entry point API.

Signature:

getEntryPointApi(pluginId: string, apiVersion: '1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '1.5' | '1.6' | '1.7' | '1.8'): 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.
apiVersion	'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '1.5' | '1.6' | '1.7' | '1.8'	The required version of the API, as major.minor; for example, '1.0'. Use the same major.minor as the version of the SDK.

Returns:

Promise<IEntryPointApi>

A promise that resolves to the requested entry point API.

Exceptions

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