Méthodes Microsoft.CIFramework (référence d’API JavaScript pour Environnement d’intégration du canal de Dynamics 365 1.0)
Microsoft CIFramework fournit des méthodes pour utiliser l’API JavaScript pour gérer le panneau de communication, les enregistrements et les formulaires dans l’application pilotée par modèle Dynamics 365.
Important
- Le gestionnaire d’événements CIFInitDone doit être invoqué avant d’appeler les autres API.
- Le délai d’expiration des API est de 10 secondes. Si les API ne s’exécutent pas dans les 10 secondes, elles doivent être réexécutées avec des paramètres ou une portée modifiés.
API de gestion du volet de communication
Le volet Communications vous permet, en tant qu’agent, d’interagir avec le client. Les widgets partenaires créés avec Environnement d’intégration du canal 1.0 sont chargés dans ce panneau. Le widget de cette version est affiché à droite de l’écran et prend en charge les modes Ancré et Minimisé.
Utilisez les API suivantes pour gérer l’état du panneau de communication (widget).
| Méthodes | Description |
|---|---|
| setWidth | Définit la largeur du panneau pour toutes les sessions. |
| getWidth | Obtient la largeur du volet en pixels. |
| setMode | Définit l’état du volet. |
| getMode | Définit l’état du volet. |
API d’opérations CRUD
Utilisez les API suivantes pour effectuer des opérations CRUD sur les enregistrements d’entité.
| Méthodes | Description |
|---|---|
| createRecord | Crée un enregistrement d’entité. |
| retrieveRecord | Récupère un enregistrement d’entité. |
| updateRecord | Met à jour un enregistrement d’entité. |
| deleteRecord | Supprime un enregistrement d’entité. |
Méthodes diverses
| Méthodes | Description |
|---|---|
| getEntityMetadata | Renvoie les métadonnées pour l’entité spécifiée. |
| setClickToAct | Définit une valeur booléenne pour activer ou désactiver la communication sortante (ClickToAct). |
| getClickToAct | Renvoie une valeur booléenne pour indiquer si la communication sortante (ClickToAct) est activée ou non. |
| searchAndOpenRecords | La méthode recherche l’enregistrement du widget de communication pendant la communication entrante et ouvre l’enregistrement. |
| getEnvironment | Permet d’obtenir des détails sur l’application et la page Unified Interface actuelles. Les détails incluent l’ID d’application (appid), le type de page (pageType), l’ID d’enregistrement (id), la géographie de l’organisation (orgGeo) et le type de navigation de session (navigationType). |
| openForm | Ouvre un formulaire d’entité ou un formulaire de création rapide. |
| renderSearchPage | Vous permet de rechercher parmi les enregistrements d’un type d’entité spécifique. Cette API ouvre la page d’entité Unified Interface avec le champ de recherche déjà complété avec la chaîne recherchée transmise comme paramètre. |
| addHandler | Ajoute l’abonné aux événements.
Note Cette API peut être utilisée à la fois sur le widget et sur la page Unified Interface. |
| removeHandler | Supprime l’abonné des événements.
Note Cette API peut être utilisée à la fois sur le widget et sur la page Unified Interface. |
| raiseEvent | Appelle l’abonné associé à l’événement.
Note Si vous avez créé des événements personnalisés à l’aide de la méthode addHandler, vous pouvez déclencher ces événements en passant le nom de l’événement en tant que paramètre dans cette méthode. |
| updateContext | Cette méthode vous permet de définir le dictionnaire d’automatisation. |
Voir aussi
Nouveautés de l’Environnement d’intégration du canal Dynamics 365
Configuration requise de l’Environnement d’intégration du canal de Dynamics 365 1.0