SidePaneContext
The object that encapsulates the UEF-provided sidePane events and actions support. This object is added on top of UEF provider object to access sidePane events and perform actions on sidePane actions in the Fusion application. You can get the sidePaneContext by calling the getSidePaneContext API provided in the UEF provider object.
Syntax
Here's the syntax:
getSidePaneContext(sidePaneId: string): Promise<ISidePaneContext>;The following code Typescript sample shows how you can pass sidePanelId to access
SidePaneContext:
const uiEventsFrameworkInstance: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
const sidePaneContext: ISidePaneContext = await uiEventsFrameworkInstance.getSidePaneContext('sidePaneId');The following code JavaScript sample shows how you can pass sidePanelId to access
SidePaneContext:
const uiEventsFrameworkInstance = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('appname', 'v1');
const sidePaneContext = await uiEventsFrameworkInstance.getSidePaneContext('sidePaneId');Note: See the Configuration of ServiceCenter/fusionapp
SidePane section to know how user can configure UEF Supported advanced side pane
in fusion application. The sidePaneContext refers to only the advanced sidePane,
the UEF legacy sidePane can't be controlled using this object.
Supported Operations
| Operation Name | Description | Example |
|---|---|---|
| ExpandSidePane | Used to expand a particular SidePane. | ExpandSidePane |
| CollapseSidePane | Used to collapse a particular SidePane. | CollapseSidePane |
| UpdateSidePane - setVisiblity | Used to set the visibility (true or false) of a particular SidePane. | UpdateSidePane - setVisiblity |
| UpdateSidePane - setIcon | Used to set icon for a particular SidePane Icon. | UpdateSidePane - setIcon |
| UpdateSidePane - setSectionId | Used to set section ID for a particular SidePane. | UpdateSidePane - setSectionId |
Supported Events
| Event Name | Description |
|---|---|
| SidePaneOpen | Started when a SidePane is opened. |
| SidePaneClose | Started when a SidePane is closed. |
Note: These events notifications are started for the
particular sidePaneContext object corresponding to a sidePaneId on which user
has added a subscription.
Supported Methods
| subscribe | Function to listen to a SidePaneContext supported event, such as SidePaneOpen or SidePaneClose. | subscribe |
| subscribeOnce | Function to listen once a SidePaneContext supported event such as SidePaneOpen, or SidePaneClosed is launched. | subscribeOnce |
| publish | Function to publish a SidePane supported operation on SidePaneContext object. For example, ExpandSidePane, CollapseSidePane, UpdateSidePane | publish |
| dispose | Function to dispose/remove all events subscribed on SidePaneContext object. | dispose |
| getSupportedEvents | Function to get all the supported events on SidePaneContext object. | getSupportedEvents |
| getSupportedActions | Function to get all the supported actions on SidePaneContext object. | getSupportedActions |
| getSidePaneContextId | Function to get the sidePane contextId of the SidePaneContext object. | getSidePaneContextId |