TabContext
TabContextを使用すると、ContextOpen、ContextCloseなどのタブ・レベルのイベントをリスニングし、FocusTabやCloseTabなどのタブ・レベルの操作を実行できます。
TabContextの参照を取得するために、ユーザーはgetTabContext関数を使用できます。 この関数は、アプリケーションがロードされるアクティブなタブへの参照を提供します。 browserTabIdをオプションのパラメータとして渡して、特定のブラウザ・タブのコンテキストを取得できます。
構文
構文は次のとおりです:
getTabContext(browserTabId?: string): Promise<ITabContext>;
パラメータ
パラメータ名 | 必須かどうか | 説明 |
---|---|---|
browserTabId | No |
特定のブラウザ・タブのID。
ノート: 各ブラウザ・タブからframeworkProviderでgetCurrentTabId APIをコールすることで、各ブラウザのtabId値を取得できます。 |
コード・サンプル
TypeScriptのコード・サンプルを次に示します:
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID');
const tabContext: ITabContext = await frameworkProvider.getTabContext();
JavaScriptのコード・サンプルを次に示します:
const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID');
const tabContext = await frameworkProvider.getTabContext();
サポートされているイベント
イベント名 | 説明 | 例 |
---|---|---|
ContextOpen | 特定のタブで新しいオブジェクトを開いたときに開始されます。 | 相互参照を含む |
ContextClose | オブジェクトが特定のタブで閉じられると開始されます。 | |
CustomEvent | ビジネス固有のカスタム・イベントをサポートするために使用されます。 |
サポートされている操作
処理名 | 説明 | 例 |
---|---|---|
FocusTab | 特定のブラウザまたはMSIタブにフォーカスするために使用されます。 | |
CloseTab | 特定のブラウザまたはMSIタブを閉じる場合に使用します。 | |
PopOperation | 指定したタブ・コンテキスト内のアプリケーション・ページやカスタム・ページなど、任意のページをポップするために使用します。 | |
GetAgentInfo | 現在ログインしているユーザーに関する情報をフェッチするために使用されます。 | |
CustomEvent | ビジネス固有のカスタム・イベントをサポートするために使用されます。 | |
OpenModal | モーダル・ウィンドウを開くときに使用します。 | |
CloseModal | モーダル・ウィンドウを閉じるときに使用します。 | |
OpenPopup | ポップアップ・ウィンドウを開くときに使用します。 | |
ClosePopup | ポップアップ・ウィンドウを閉じる場合に使用します。 |
サポートされているメソッド
メソッド名 | 説明 |
---|---|
サブスクライブ | Fusionアプリケーションから起動されたイベントへのサブスクライブに使用されます。 |
subscribeOnce | Fusionアプリケーション・イベントを1回のみサブスクライブするために使用されます。 |
公開 | 特定の操作を実行するために使用されます。 |
処分 | イベントに追加されたサブスクリプションの処分または登録解除に使用されます。 |
getSupportedEvents | GlobalContextでサポートされているイベントのリストを取得するために使用されます。 |
getSupportedActions | GlobalContextでサポートされている操作のリストを取得するために使用されます。 |
getType | tabContextオブジェクトの型を返します。 |
getAvailableTabs | 特定のタブまたはそのtabContextの上にある使用可能なすべてのタブを返します。 |
getAvailableRecords | 特定のタブで使用可能なすべてのレコードを返します。 |
getActiveRecord |
特定のタブのアクティブなレコードを返します。 |
getDependentTabs | タブ・コンテキストから開いたすべての子タブを返します。 |