IEngagementInfo
このオブジェクトは、TabContextに関連付けられたエンゲージメントに関する情報を保持します。
関数
getEngagementId
この関数を使用して、エンゲージメントのエンゲージメントIDを取得します。
構文は次のとおりです:
getEngagementId(): string;
getEngagementType
この関数を使用して、エンゲージメントのエンゲージメント・タイプを取得します。
構文は次のとおりです:
getEngagementType(): string;
getInteractionId
この関数を使用して、エンゲージメントの相互作用IDを取得します。
構文は次のとおりです:
getInteractionId(): string;
getWrapUpId
この関数を使用して、エンゲージメントのラップ・アップIDを取得します。
構文は次のとおりです:
getWrapUpId(): string;
getInData
この関数を使用して、エンゲージメントのデータを取得します。
構文は次のとおりです:
getInData(): Record<any, any>;
getOutData
この関数を使用して、エンゲージメントのデータを取得します。
構文は次のとおりです:
getOutData(): Record<any, any>;
isActiveEngagement
エンゲージメントがアクティブかどうかに関する情報を返すには、この関数を使用します。
構文は次のとおりです:
isActiveEngagement(): boolean;
次のコード・サンプルは、現在のブラウザ・タブ・コンテキストのエンゲージメント情報を取得するためのTypescriptの例を示しています。
let uefProvider = await UIEventsAPPFramework.UefClient.getUEFProvider();
let frameworkProvider: IUiEventsFrameworkProvider = await uefProvider.uiEventsFramework.initialize('My App');
let tabContext: ITabContext = await frameworkProvider.getCurrentBrowserTabContext();
let engagementInfo: IEngagementInfo = await tabContext.getEngagementInfo();
console.log(engagementInfo.getEngagementId());
console.log(engagementInfo.getEngagementType());
console.log(engagementInfo.getInteractionId());
console.log(engagementInfo.getWrapUpId());
console.log(engagementInfo.getInData());
console.log(engagementInfo.getOutData());
console.log(engagementInfo.isActiveEngagement());
次のコード・サンプルは、現在のブラウザ・タブ・コンテキストのエンゲージメント情報を取得するためのJavaScriptの例を示しています。
let uefProvider = await UIEventsAPPFramework.UefClient.getUEFProvider();
let frameworkProvider = await uefProvider.uiEventsFramework.initialize('My App');
let tabContext = await frameworkProvider.getCurrentBrowserTabContext();
let engagementInfo = await tabContext.getEngagementInfo();
console.log(engagementInfo.getEngagementId());
console.log(engagementInfo.getEngagementType());
console.log(engagementInfo.getInteractionId());
console.log(engagementInfo.getWrapUpId());
console.log(engagementInfo.getInData());
console.log(engagementInfo.getOutData());
console.log(engagementInfo.isActiveEngagement());