cancelEvent (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 2.0
Bricht die Benachrichtigung über eingehende Unterhaltungen basierend auf dem Abbruchtoken ab.
Syntax
Microsoft.CIFramework.cancelEvent(cancellationToken, correlationId).then(successCallback, errorCallback);
Parameter
Name des Dataflows | Typ | Erforderlich | Beschreibung |
---|---|---|---|
cancellationToken | Zeichenfolge | Ja | Eindeutige Zeichenfolge, die von der notifyEvent -Methode zum Abbrechen von Benachrichtigungen über eingehende Gespräche angezeigt wird. |
correlationId | GUID | Nein | Zur Gruppierung aller verwandten API-Aufrufe für die diagnostische Telemetrie. |
successCallback | Funktion | Nein | Eine Funktion, die bei erfolgreicher Anfrage aufgerufen wird. Bei einem erfolgreichen Rückruf enthält das Antwortobjekt das Abbruchtoken. |
errorCallback | Funktion | Nein | Eine Funktion, die aufgerufen wird, wenn die Anforderung fehlschlägt. |
Details zur Callback-Funktion
Die folgenden Objekte werden an die Funktionen successCallback
und errorCallback
übergeben.
successCallback Funktion
Gibt das Stornierungstoken zurück.
errorCallback Funktion
JSON-Beispielobjekt:
{
"message" : "<error details>",
"msdyn_name" : "CancelEvent"
}
Parameter
Nachricht | Beschreibung |
---|---|
RejectAfterClientError | Es ist eine unbekannte Ausnahme aufgetreten (tritt auf, wenn der Plattform-API-Aufruf fehlschlägt oder ein Eingabeparameter fehlt) |
Beispiel
// Trying to cancel a notification, use the same cancelToken passed during creation of notification in notifyEvent
Microsoft.CIFramework.cancelEvent(CancelToken).then(
function success(result) {
console.log(result);
// Perform operations
},
function (error) {
console.log(error.message);
// Handle error conditions
}
);