IUIEventsFramework

The IUiEventsFramework object is used to initialize the uiEventsFramework by providing an App ID.

All the APIs of the ui-events-framework can be called on top of the object which is available after initializing the ui-events-framework from the client side. To generate that framework provider object, the call to the initialize method supported by IUiEventsFramework object must be made.

Functions

The following code sample shows an example in JavaScript of how to generate the request object for performing an operation initialize.

All the APIs of ui-events-framework can be only called once the framework is initialized from client DOM. The object which we receive by initializing could be used to call those APIs.

The following code sample shows the syntax for initialize API.

initialize(applicationName: string, version: string): Promise<IUiEventsFrameworkProvider>;

Parameter	Required?	Description
applicationName	Yes	An application name to initialize the framework with.
version	No	A version to initialize the framework with.

The following code sample shows an example in typescript.

/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: CX_SVC_UI_EVENTS_FRAMEWORK.IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID', 'v1');

The following code sample shows an example in JavaScript.

const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID', 'v1');