Microsoft.CIFramework methods (CIF JavaScript API reference)

Provides methods to use JavaScript API to manage the channel (widget), records, and forms in the Dynamics 365.


Methods Description
setWidth Sets the panel width.
getWidth Gets the panel width in pixels.
getEntityMetadata Returns the entity metadata for the specified entity.
setMode Sets the state of the panel.
getMode Sets the state of the panel.
setClickToAct Sets a Boolean value to enable or disable the outbound communication (ClickToAct).
getClickToAct Returns a Boolean value to indicate whether the outbound communication (ClickToAct) is enabled or not.
searchAndOpenRecords The method searches for the record from the communication widget during the inbound communication and opens the record.
getEnvironment Gets the current Unified Interface app and page details. The details include appId, pageType, and recordId (If available).
openForm Opens an entity form or a quick create form.
renderSearchPage Allows you to search among the records of a particular entity type. This API opens the Unified Interface entity page with the search field on it prepopulated with the search string that is passed as a parameter.
createRecord Creates an entity record.
retrieveRecord Retrieves an entity record.
updateRecord Updates an entity record.
deleteRecord Deletes an entity record.
addHandler Add the subscriber to the events.
removeHandler Remove the subscriber from the events.