iRequestHelper

IRequestHelper has the following functions:

createSubscriptionRequest

This function is used to create requestObject for event subscription.

Here are the parameters:

Parameter	Required?	Description
eventName	Yes	Event name to be subscribed to.

The following code sample shows an example in Typescript:

/// <reference path="uiEventsFramework.d.ts"/>
      const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
      const globalContext: IGlobalContext = await frameworkProvider.getGlobalContext();
      const requestObject: IEventRequest = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusTabCloseEvent');
      const subscriptionContext: ISubscriptionContext = globalContext.subscribe(requestObject, (response: IEventResponse) => {
           // custom code
      });
      

The following code sample shows an example in Javascript:

const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');    
      const globalContext = await  frameworkProvider.getGlobalContext();   
      const requestObject = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusTabCloseEvent');
        
      globalContext.subscribe(requestObject,(response) => {
          // custom code
      });
  

createPublishRequest

This function is used to create requestObject for event subscription.

Here are the parameters:

Parameter	Required?	Description
operationName	Yes	Operation name to be subscribed to.

The following code sample shows an example in Typescript:

/// <reference path="uiEventsFramework.d.ts"/>
       
      const frameworkProvider: IUiEventsFrameworkProvider =
      await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1'); 
      const globalContext: IGlobalContext = await frameworkProvider.getGlobalContext();
      const requestObject: IOperationRequest = frameworkProvider.requestHelper.createPublishRequest('cxEventBusCustomEventOperation');
      requestObject.setCustomEventName('someName');
      globalContext.publish(requestObject: IOperationRequest ).then((message: IOperationResponse) => {
          //custom code
      }).catch((error: IErrorData) => {
          console.log(error.getMessage());
      });
  

The following code sample shows an example in Javascript to generate request object for performing an operation.

const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1'); 
      const globalContext = await frameworkProvider.getGlobalContext();
      const requestObject = frameworkProvider.requestHelper.createPublishRequest('cxEventBusCustomEventOperation');
      requestObject.setCustomEventName('someName');
      globalContext.publish(requestObject).then((message) => {
          //custom code
      }).catch((error: IErrorData) => {
          console.log(error.getMessage());
      });