IOpenModalWindowRequest

Pass this object as the request object for modal operation publish API.

Functions

setId

Use this function to set the Unique ID of the modal. In a success response, you'll get the same Id value:

setId(id: boolean): void;

Parameter

Parameter Name	Required?	Description
Id	Yes	Unique ID of the modal.

setUrl

Use this function to set the URL of the modal content. This URL render in an iFrame to display in the modal.

setURL(url: string): void;

Parameter

Parameter Name	Required?	Description
url	Yes	Content of the modal.

setTitle

Use this function to set the title of the modal.

setTitle(title: string): void;
  

Parameter

Parameter Name	Required?	Description
Title	No	Title of the modal.

setClosable

Use this function to set the modal closable or not. If it isn't set to True, the Close icon won't be available in the modal. You must close it with the CloseModal operation:

setClosable(closable: boolean): void;
  

Parameter

Parameter Name	Required?	Description
closable	No	The default value is False, and the Close icon wont be available in the modal. You need to close it with CloseModal operation.

setStyle

Use this function to set the style of the modal:

setStyle(style: any): void;

Parameter

Parameter Name	Required?	Description
style	No	The style of the object. For example: width: 100px, height 100px.

Here's an example in Typescript of the OpenModal action:

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://slc05zrk.us.oracle.com:8080/clientAppTest/modalClose.html');     
      requestObject.setId('modal_103');     
      requestObject.setTitle('Test title');    
      requestObject.setClosable(true);     
      requestObject.setStyle({width:'1000px', height:'1000px'});    
      const response: IModalWindowOperationResponse = await modalWindowContext.publish(requestObject) as IModalWindowOperationResponse;    
      const id:string = response.getResponseData().getId(); 
  }
  

Here's an example in JavaScript of of SidePaneOpen event subscription.

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://slc05zrk.us.oracle.com:8080/clientAppTest/modalClose.html');     
      requestObject.setId('modal_103');     
      requestObject.setTitle('Test title');     
      requestObject.setClosable(true);     
      requestObject.setStyle({ width:'1000px', height:'1000px' });     
      const response = await modalWindowContext.publish(requestObject);    
      const id = response.getResponseData().getId(); 
  }