Microsoft.CIFramework-Methoden (Dynamics 365-Kanalintegrationsframework 1.0 JavaScript API-Referenz)
Microsoft CIFramework bietet Methoden zur Verwendung der JavaScript-API zum Verwalten des Kommunikationsbereichs, Datensätze und Formulare in der modellgesteuerten Dynamics 365 App.
Wichtig
- Der CIFInitDone-Ereignishandler muss vor dem Aufruf der anderen APIs aufgerufen werden.
- Das Timeout-Limit für die APIs beträgt 10 Sekunden. Wenn die APIs nicht innerhalb von 10 Sekunden ausgeführt werden, müssen sie mit geänderten Parametern oder geändertem Umfang erneut ausgeführt werden.
Kommunikationsbereich für die APIs Verwaltung
Der Kommunikationsbereich ist der Ort, an dem Sie sich als Agent mit Kunden in Verbindung setzen. In diesem Bereich werden Partner-Widgets geladen, die mit Kanalintegdrationsframework 1.0 erstellt wurden. Das Widget in dieser Version wird rechts der Anzeige angezeigt und unterstützt die Modi Angehefted, Minimiert.
Verwenden Sie die folgenden APIs, um den Status des Kommunikationsbereichs (Widgets) zu verwalten.
| Methoden | Beschreibung |
|---|---|
| setWidth | Legt die Bereichsbreite für alle Sitzungen fest. |
| getWidth | Ruft die Bereichsbreite in Pixel ab. |
| setMode | Legt den Bereichsstatus fest. |
| getMode | Legt den Bereichsstatus fest. |
CRUD-Operationen APIs
Verwenden Sie die folgenden APIs, um CRUD-Vorgänge für Entitätsdatensätze durchzuführen.
| Methoden | Beschreibung |
|---|---|
| createRecord | Erstellt einen Entitätsdatensatz. |
| retrieveRecord | Ruft einen Entitätsdatensatz ab. |
| updateRecord | Aktualisiert einen Entitätsdatensatz. |
| deleteRecord | Löscht einen Entitätsdatensatz. |
Verschiedene Methoden
| Methoden | Beschreibung |
|---|---|
| getEntityMetadata | Gibt die Entitätsmetadaten für die angegebene Entität zurück. |
| setClickToAct | Legt einen Booleschen Wert fest, um ausgehende Kommunikation (ClickToAct) zu aktivieren oder zu deaktivieren. |
| getClickToAct | Gibt einen Booleschen Wert zurück, um anzugeben, ob die ausgehende Kommunikation (ClickToAct) aktiviert ist oder nicht. |
| searchAndOpenRecords | Das Verfahren sucht während des Nachrichteneingangs nach dem Datensatz aus dem Kommunikations-Widget und öffnet ihn. |
| getEnvironment | Ruft die aktuellen App- und Seiteninformationen der Einheitlichen Oberfläche ab. Zu den Details gehören Anwendungs-ID (appid), der PageType (pageType), die Datensatz-ID (id), Organisationsgeografie (orgGeo) und der Sitzungsnavigationstyp (navigationType). |
| openForm | Öffnet ein Entitätsformular oder ein Schnellerfassungsformular. |
| renderSearchPage | Ermöglicht die Suche in Datensätzen eines bestimmten Entitätstyps. Die API öffnet die Entitätsseite der einheitlichen Oberfläche mit vorab ausgefülltem Suchfeld und der Suchzeichenfolge, die als Parameter übergeben wird. |
| addHandler | Fügen Sie den Abonnenten den Ereignissen hinzu.
Anmerkung Diese API kann sowohl auf dem Widget als auch auf der Einheitliche Oberfläche-Seite verwendet werden. |
| removeHandler | Entfernt den Abonnenten aus den Ereignissen.
Anmerkung Diese API kann sowohl auf dem Widget als auch auf der Einheitliche Oberfläche-Seite verwendet werden. |
| raiseEvent | Ruft den zugehörigen Abonnenten für das Ereignis auf.
Anmerkung Wenn Sie benutzerdefinierte Ereignisse mit der addHandler-Methode erstellt haben, können Sie diese Ereignisse auslösen, indem Sie den Ereignisnamen als Parameter in dieser Methode übergeben. |
| updateContext | Mit dieser Methode können Sie das Automatisierungswörterbuch einstellen. |
Siehe auch
Was ist neu in Dynamics 365 Kanalintegrationsframework
Systemanforderungen des Dynamics 365-Kanalintegrationsframework 1.0