IEngagementInfo

This object holds information about an engagement associated with a TabContext.

Functions

getEngagementId

Use this function to get engagement ID of an engagement..

Here's the syntax:

getEngagementId(): string;

getEngagementType

Use this function to get the engagement type of an engagement.

Here's the syntax:

getEngagementType(): string; 

getInteractionId

Use this function to get the interaction ID of an engagement.

Here's the syntax:

getInteractionId(): string; 

getWrapUpId

Use this function to get the wrap up ID of an engagement.

Here's the syntax:

getWrapUpId(): string;

getInData

Use this function to get in data of an engagement.

Here's the syntax:

getInData(): Record<any, any>;

getOutData

Use this function to get out data of an engagement.

Here's the syntax:

getOutData(): Record<any, any>;

isActiveEngagement

Use this function to return information on whether an engagement is active or not.

Here's the syntax:

isActiveEngagement(): boolean;

The following code sample shows an example in Typescript for getting the engagement information for current browser tab context.

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());

The following code sample shows an example in JavaScript for getting the engagement information for current browser tab context.

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());