UIイベント・フレームワークの使用方法
UIイベント・フレームワークで公開されているAPIを使用するには、次のステップに従う必要があります:
前提条件
- <oj-cx-svc-common-ui-events-container>コンポーネントを使用して、Fusionアプリケーションに外部アプリケーションをロードします。
- 外部アプリケーションのHTMLまたはDOMファイルにUIイベント・フレームワーク・ライブラリ・ファイルをロードします。
必須ステップ
- UIイベント・フレームワークの初期化
- ユースケースに対応するコンテキストの取得
- リクエストを使用したリクエスト・オブジェクトの生成
- 前のコンテキストで公開されたAPIの起動
UIイベント・フレームワークの初期化
相互作用のアプリケーション名を使用してフレームワークを初期化する必要があります。 フレームワークが正常に初期化されると、IUiEventsFrameworkProvider
のインスタンスへの参照を取得できます。 このオブジェクトから発生したすべての相互作用は、初期化中に指定したアプリケーション名で追跡できます。
構文は次のとおりです:
initialize(applicationId: string, versioninitialize(applicationId: string, version: string): Promise<IUiEventsFrameworkProvider>;: string): Promise<IUiEventsFrameworkProvider>;
パラメータは次のとおりです:
パラメータ名 | 必須かどうか | 説明 |
---|---|---|
applicationId | Yes | UIイベント・フレームワークを使用するには、一意のアプリケーションIDを持つinitialise 関数をコールする必要があります。 アプリケーションIDは、テスト中のデバッグに役立ちます。 |
翻訳 | No |
Oracleは、すべてのリリースに対して下位互換性を維持することを目指しています。 将来、フレームワークが下位互換性のない一部のAPIを非推奨にした場合、このパラメータを使用して、ライブラリの古いバージョンまたは新しいバージョンをロードできます。 現在、「バージョン」のデフォルト値はv1です。 現時点では、このバージョン値は設定できません。 |
Typescriptの例を次に示します:
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID','v1');
Javascriptの例を次に示します:
const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID','v1');
ユースケースに対応するコンテキストの取得
IUiEventsFrameworkProvider
のインスタンスを取得したら、ユース・ケースに基づいてコンテキストを選択できるようになりました。 UiEventsFrameworkProvider
には、次の表に示す5つのコンテキストがあります:
コンテキスト | 説明 | トピック |
---|---|---|
GlobalContext | アプリケーション・レベルのイベントをリスニングし、アプリケーション・レベルの操作を実行できます。 | IGlobalContext |
TabContext | タブ・レベルのイベントをリスニングできます。 | ITabContext |
RecordContext | オブジェクトに関連するすべてのイベントまたは操作をリスニングできます。 | IRecordContext |
SidePaneContext | sidePaneのイベントにアクセスし、FusionアプリケーションでアクションonsidePaneを実行できます。 | ISidePaneContext |
ModalWindowContext | FusionアプリケーションのModalWindowに対してアクションを実行できます。 | IModalWindowContext |
NotificationContext | Fusionアプリケーションで通知アクションおよびイベントを実行できます。 | INotificationContext |
InsightsContext | 特定のレコード・コンテキストからインサイトCCA関連処理およびイベントを実行できます | InsightsContext |
UIイベント・フレームワークの拡張可能なイベントおよびアクションはすべて、GlobalContext、TabContext、RecordContextなどのコンテキストでサポートされます。 次の図は、フレームワークで保守されるこれらのコンテキストの階層と、各コンテキストでサポートされているイベント、アクションおよびAPIを示しています。 以降のセクションでは、各コンテキストについて詳しく説明します。