IPopFlowAppUIRequest

This object must be passed as the request object for pop operation publish API to open Application UI pages.

Functions

setFlow

This function is used to set flow of application. .

The following example shows the syntax:
setFlow(flow: string): void;

The following table shows the parameter:

Parameters

Parameter Name Required? Description
flow No Flow name of the page.

setPage

Function set to set the page of the application.

The following example shows the syntax:
setPage(page: string): void;

The following table shows the parameter:

Parameters

Parameter Name Required? Description
page No The name of the page.
The following code snippet shows an example in Typescript:
const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1'); 
      const globalContext: IGlobalContext = await  frameworkProvider.getGlobalContext(); 
      const requestObject: IPopFlowAppUIRequest = frameworkProvider.requestHelper.createPublishRequest('PopOperation') as IPopFlowAppUIRequest;
      requestObject.setFlow('ec');
      requestObject.setPage('edit');
      requestObject.setInputParameters({contactId: 'C242'});
      requestObject.setOpenPageInNewBrowserTab(true); 
      const response: IPopFlowResponse = await globalContext.publish(requestObject) as IPopFlowResponse;

The following code snippet 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.createPublishRequest('PopOperation');
      requestObject.setFlow('ec');
      requestObject.setPage('edit');
      requestObject.setInputParameters({contactId: 'C242'});
      requestObject.setOpenPageInNewBrowserTab(true);
      const response = await globalContext.publish(requestObject);