IUIEventsFramework
IUiEventsFrameworkオブジェクトは、アプリケーションIDを指定してuiEventsFrameworkを初期化するために使用されます。
ui-events-frameworkのすべてのAPIは、クライアント側からui-events-frameworkを初期化したあとに利用可能なオブジェクト上で呼び出すことができます。 そのフレームワーク・プロバイダ・オブジェクトを生成するには、IUiEventsFrameworkオブジェクトでサポートされるinitialiseメソッドをコールする必要があります。
関数
次のコード・サンプルは、JavaScriptで、操作の初期化を実行するためのリクエスト・オブジェクトの生成方法の例を示しています。
ui-events-frameworkのすべてのAPIは、フレームワークがクライアントDOMから初期化された後にのみ起動できます。 初期化によって受信するオブジェクトを使用して、これらのAPIを呼び出すことができます。次のコード・サンプルは、initialize APIの構文を示しています。
initialize(applicationName: string, version: string): Promise<IUiEventsFrameworkProvider>;
パラメータ | 必須かどうか | 説明 |
---|---|---|
applicationName | Yes | フレームワークを初期化するアプリケーション名。 |
翻訳 | No | フレームワークを初期化するバージョン。 |
次のコード・サンプルは、typescriptの例を示しています。
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: CX_SVC_UI_EVENTS_FRAMEWORK.IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID');
次のコード・サンプルは、Javacriptの例を示しています。
const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID');