microsoft-ciframework.md

title	description	ms.date	ms.topic	author	ms.author	applies_to	ms.custom
Microsoft.CIFramework (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0 | MicrosoftDocs	Includes reference information about the Microsoft.CIFramework JavaScript API Reference for Dynamics 365 Channel Integration Framework 1.0.	03/14/2022	reference	gandhamm	mgandham	Dynamics 365 for Customer Engagement (online)	dyn365-a11y dyn365-developer

Microsoft.CIFramework methods (Dynamics 365 Channel Integration Framework 1.0 JavaScript API reference)

Microsoft CIFramework provides methods to use JavaScript API to manage the communication panel, records, and forms in the Dynamics 365 model-driven app.

Important

• The CIFInitDone event handler must be invoked before calling the other APIs.
• The time-out limit for the APIs is 10 seconds. If the APIs don't run within 10 seconds, they must be run again with changed parameters or scope.

Communication panel management APIs

The communication panel is where you, as an agent, interact with the customer. Partner widgets built using Channel Integration Framework 1.0 are loaded in this panel. The widget in this version is displayed to the right of the screen, and supports Docked and Minimized modes.

Use the following APIs to manage the state of the communication panel (widget).

Methods	Description
setWidth	[!INCLUDEsetWidth-description]
getWidth	[!INCLUDEgetWidth-description]
setMode	[!INCLUDEsetMode-description]
getMode	[!INCLUDEgetMode-description]

CRUD operations APIs

Use the following APIs to perform CRUD operations on entity records.

Methods	Description
createRecord	[!INCLUDEcreateRecord-description]
retrieveRecord	[!INCLUDEretrieveRecord-description]
updateRecord	[!INCLUDEupdateRecord-description]
deleteRecord	[!INCLUDEdeleteRecord-description]

Miscellaneous methods

Methods	Description
getEntityMetadata	[!INCLUDEgetEntityMetadata-description]
setClickToAct	[!INCLUDEsetClickToAct-description]
getClickToAct	[!INCLUDEgetClickToAct-description]
searchAndOpenRecords	[!INCLUDEsearchAndOpenRecords-description]
getEnvironment	[!INCLUDEgetEnvironment-description]
openForm	[!INCLUDEopenForm-description]
renderSearchPage	[!INCLUDEopenForm-description]
addHandler	[!INCLUDEaddHandler-description]
removeHandler	[!INCLUDEremoveHandler-description]
raiseEvent	[!INCLUDEraiseEvent-description]
updateContext	This method allows you to set the automation dictionary.

See also

What's new in Dynamics 365 Channel Integration Framework
System requirements of Dynamics 365 Channel Integration Framework 1.0

[!INCLUDEfooter-include]