SidePaneContext
UEF提供のsidePaneイベントおよびアクション・サポートをカプセル化するオブジェクト。 このオブジェクトは、UEFプロバイダ・オブジェクトの上部に追加され、sidePaneイベントにアクセスし、FusionアプリケーションのsidePaneアクションに対してアクションを実行します。 sidePaneContextを取得するには、UEFプロバイダ・オブジェクトで提供されているgetSidePaneContext APIをコールします。
構文
構文は次のとおりです:
getSidePaneContext(sidePaneId: string): Promise<ISidePaneContext>;次のコードTypescriptサンプルは、sidePanelIdを渡してSidePaneContextにアクセスする方法を示しています:
const uiEventsFrameworkInstance: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
const sidePaneContext: ISidePaneContext = await uiEventsFrameworkInstance.getSidePaneContext('sidePaneId');次のコードJavaScriptサンプルは、sidePanelIdを渡してSidePaneContextにアクセスする方法を示しています:
const uiEventsFrameworkInstance = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
const sidePaneContext = await uiEventsFrameworkInstance.getSidePaneContext('sidePaneId');ノート: 「ServiceCenter/fusionapp SidePane」の構成に関する項を参照して、ユーザーがFusionアプリケーションでUEFでサポートされている拡張サイド・ペインを構成する方法を確認してください。 sidePaneContextは拡張sidePaneのみを参照し、UEFレガシーsidePaneはこのオブジェクトを使用して制御できません。
サポートされている操作
| 工程名 | 説明 | 例 |
|---|---|---|
| ExpandSidePane | 特定のSidePaneを拡張するために使用します。 | ExpandSidePane |
| CollapseSidePane | 特定のSidePaneを縮小するために使用します。 | CollapseSidePane |
| UpdateSidePane - setVisiblity | 特定のSidePaneの表示設定(trueまたはfalse)に使用されます。 | UpdateSidePane - setVisiblity |
| UpdateSidePane - setIcon | 特定のSidePaneアイコンのアイコンを設定するために使用します。 | UpdateSidePane - setIcon |
| UpdateSidePane - setSectionId | 特定のSidePaneのセクションIDを設定するために使用します。 | UpdateSidePane - setSectionId |
サポートされているイベント
| イベント名 | 説明 |
|---|---|
| SidePaneOpen | SidePaneが開いたときに起動されます。 |
| SidePaneClose | SidePaneがクローズされたときに起動されます。 |
ノート: これらのイベント通知は、ユーザーがサブスクリプションを追加したsidePaneIdに対応する特定のsidePaneContextオブジェクトに対して開始されます。
サポートされているメソッド
| サブスクライブ | SidePaneContextでサポートされているイベント(SidePaneOpenやSidePaneCloseなど)をリスニングするファンクション。 | サブスクライブ |
| subscribeOnce | SidePaneContextでサポートされているイベント(SidePaneOpen、SidePaneClosedなど)が起動されるとリスニングするファンクション。 | subscribeOnce |
| 公開 | SidePaneContextオブジェクトでSidePaneでサポートされている操作を公開するファンクション。 たとえば、ExpandSidePane、CollapseSidePane、UpdateSidePaneです | 公開 |
| 処分 | SidePaneContextオブジェクトでサブスクライブされているすべてのイベントを処分または削除するファンクション。 | 処分 |
| getSupportedEvents | SidePaneContextオブジェクトでサポートされているすべてのイベントを取得する関数。 | getSupportedEvents |
| getSupportedActions | SidePaneContextオブジェクトでサポートされているすべてのアクションを取得するファンクション。 | getSupportedActions |
| getSidePaneContextId | SidePaneContextオブジェクトのsidePane contextIdを取得するファンクション。 | getSidePaneContextId |