IModalWindowContext

This is the object which encapsulates all the UI Events Framework and provides modal and pop up window actions.

To get the reference to ModalWindowContext, you can use the getModalWindowContext function. This function provides a reference to the modalWindowContext.

Here's the syntax:

getModalWindowContext(): Promise<IModalWindowContext>;
   

The following is a code sample in Typescript.

/// <reference path="uiEventsFramework.d.ts"/>
      const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID', 'v1');
      const modalWindowContext: IModalWindowContext = await frameworkProvider.getModalWindowContext();
  
  

The following is a code sample in Javascript.

const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID', 'v1');
  const modalWindowContext = await frameworkProvider.getModalWindowContext();

Functions

publish

Use this function to publish a publish a show modal operation with ModalWindowContext object.

The following code sample shows the syntax:

publish: (requestObject: IOperationRequest) => Promise<IOperationResponse>;

The following is a code sample in Typescript:

/// <reference path="uiEventsFramework.d.ts"/>     
  const openModal = async () => {    
      const uiEventsFrameworkInstance: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
      const modalWindowContext: IModalWindowContext = await uiEventsFrameworkInstance.getModalWindowContext();    
      const requestObject: IOpenModalWindowRequest = uiEventsFrameworkInstance.requestHelper.createPublishRequest('OpenModal') as IOpenModalWindowRequest;
      requestObject.setURL('https://test.oracle.com:8080/test.html');    
      requestObject.setId('modal_103');    
      const response: IModalWindowOperationResponse = await modalWindowContext.publish(requestObject) as IModalWindowOperationResponse;   
      const id:string = response.getResponseData().getId();
  }

The following is a code sample in JavaScript:

const openModal = async () => {    
      const uiEventsFrameworkInstance = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');    
      const modalWindowContext = await uiEventsFrameworkInstance.getModalWindowContext();         
      const requestObject = uiEventsFrameworkInstance.requestHelper.createPublishRequest('OpenModal')
      requestObject.setURL('https://test.oracle.com:8080/test.html');    
      requestObject.setId('modal_103');   
      const response = await modalWindowContext.publish(requestObject);   
      const id = response.getResponseData().getId();
  }

getSupportedActions

Use this function to get get all the supported actions on ModalWindowContext object.

The following code sample shows the syntax:

getSupportedActions(): string[];

The following code sample shows example in Typescript.

/// <reference path="uiEventsFramework.d.ts"/> 
  const getSupportedActions = async () => {
  const uiEventsFrameworkInstance: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
  const modalWindowContext: IModalWindowContext = await uiEventsFrameworkInstance.getModalWindowContext();
  const supportedActions: string[] = sidePaneContext.getSupportedActions();
  }       

The following code sample shows example for getSupportedActions in Javascript.

const getSupportedActions = async () => {
      const uiEventsFrameworkInstance = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
      const modalWindowContext = await uiEventsFrameworkInstance.getModalWindowContext();
     const supportedActions = modalWindowContext.getSupportedActions();
  }