Métodos de Microsoft.CIFramework (referencia de API de JavaScript para Marco de integración de canal de Dynamics 365 1.0)
Microsoft CIFramework proporciona métodos para utilizar la API de JavaScript para administrar el panel de comunicación, los registros y los formularios en la aplicación basada en modelos de Dynamics 365.
Importante
- El controlador de eventos CIFInitDone debe invocarse antes de llamar a las otras API.
- El límite de tiempo de espera para las API es de 10 segundos. Si las API no se ejecutan en 10 segundos, se deben ejecutar nuevamente con parámetros o alcance modificados.
API de administración de panel de comunicación
El panel de comunicación es donde podrá interactuar con el cliente como agente. Los widgets de socios creados con Marco de integración de canal 1.0 se cargan en este panel. El widget en esta versión se muestra a la derecha de la pantalla y admite los modos Acoplado y Minimizado.
Utilice las siguientes API para administrar el estado del panel de comunicación (widget).
| Métodos | Descripción |
|---|---|
| setWidth | Establece el ancho del panel para todas las sesiones. |
| getWidth | Obtiene el ancho del panel en píxeles. |
| setMode | Establece el estado del panel. |
| getMode | Establece el estado del panel. |
API de operaciones CRUD
Utilice las siguientes API para realizar operaciones CRUD en registros de entidades.
| Métodos | Descripción |
|---|---|
| createRecord | Crea un registro de entidad. |
| retrieveRecord | Recupera un registro de entidad. |
| updateRecord | Actualiza un registro de entidad. |
| deleteRecord | Elimina un registro de entidad. |
Varios métodos
| Métodos | Descripción |
|---|---|
| getEntityMetadata | Devuelve los metadatos de la entidad especificada. |
| setClickToAct | Establece un valor booleano para habilitar o deshabilitar la comunicación saliente (ClickToAct). |
| getClickToAct | Devuelve un valor booleano para indicar si la comunicación saliente (ClickToAct) está habilitada o no. |
| searchAndOpenRecords | El método busca el registro en el widget de comunicación durante la comunicación entrante y abre el registro. |
| getEnvironment | Obtiene los detalles actuales de la aplicación de la Interfaz unificada y de la página. Los detalles incluyen ID de aplicación (appid), tipo de página (pageType), ID de registro (id), geografía de la organización (orgGeo) y tipo de navegación de sesión (navigationType). |
| openForm | Abre un formulario de entidad o un formulario de creación rápida. |
| renderSearchPage | Le permite buscar entre los registro de un tipo de entidad particular. Esta API abre la página de entidad de la Interfaz unificada con el campo de búsqueda en ella rellenado previamente con la cadena de búsqueda que se pasa como un parámetro. |
| addHandler | Agrega el suscriptor a los eventos.
Nota Esta API se puede utilizar tanto en el widget como en la página Interfaz unificada. |
| removeHandler | Quita el suscriptor de los eventos.
Nota Esta API se puede utilizar tanto en el widget como en la página Interfaz unificada. |
| raiseEvent | Invoca al suscriptor asociado al evento.
Nota Si ha creado eventos personalizados utilizando el método addHandler, puede generar esos eventos pasando el nombre del evento como parámetro en este método. |
| updateContext | Este método le permite configurar el diccionario de automatización. |
Consulte también
Novedades de Marco de integración de canales de Dynamics 365
Requisitos del sistema del Marco de integración de canal de Dynamics 365 1.0