ITabChangeEventResponse

This object returns the response of the TabChange event subscription.

Functions

getResponseData

Use this function to get Response data from the TabChange event subscription response.

Here's the syntax:

getResponseData(): ITabChangeResponse;

getEventName

Use this function to get the origin type of the tab change event. The tab change event origin could be from a browser tab, MSI tab or from an MSI-sub tab. .

Here's the syntax:

getType(): string;

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

const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
      const globalContext: IGlobalContext = await frameworkProvider.getGlobalContext();
      const payload: IEventRequest = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusTabChangeEvent');
      globalContext.subscribe(payload, (response: IEventResponse) => {
          let responseData = response as ITabChangeEventResponse;
          let tabChangeResponse: ITabChangeResponse = responseData.getResponseData();
          let currentTabContext: ITabContext = tabChangeResponse.getCurrentTab();
          let previousTabContext: ITabContext = tabChangeResponse.getPreviousTab();
      });

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

const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
      const globalContext = await frameworkProvider.getGlobalContext();
      const payload = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusTabChangeEvent');
      globalContext.subscribe(payload, (responseData) => {
          let tabChangeResponse = responseData.getResponseData();
          let currentTabContext = tabChangeResponse.getCurrentTab();
          let previousTabContext = tabChangeResponse.getPreviousTab();
      });