cancelEvent (JavaScript API-referens) för Dynamics 365 Channel Integration Framework 2.0

Avbryter aviseringen om inkommande konversationer baserat på annulleringstoken.

Syntax

Microsoft.CIFramework.cancelEvent(cancellationToken, correlationId).then(successCallback, errorCallback);

Parameterar

Namn Typ Krävs Description
cancellationToken String Yes Unik sträng som angavs i notifyEvent metoden för att visa meddelanden om inkommande konversationer.
correlationId GUID (globalt unikt identifierare) Nej Används för att gruppera alla relaterade API-anrop för diagnostisk telemetri.
framgångCallback Funktion Nej En funktion som ska anropas när begäran lyckas. Vid lyckat återanrop innehåller svarsobjektet annulleringstoken.
errorCallback Funktion Nej En funktion som ska anropas när begäran misslyckas.

Information om återuppringningsfunktion

Följande objekt skickas till successCallback funktionerna och errorCallback .

Funktionen successCallback

Returnerar annulleringstoken.

Funktionen errorCallback

Exempel på JSON-objekt:

{
	"message" : "<error details>",
	"msdyn_name" : "CancelEvent"
}

Parameters

meddelande Description
RejectAfterClientError Ett okänt undantag inträffade (inträffar när plattforms-API-anropet misslyckas eller någon indataparameter saknas)

Example

// 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
                }
);
  • Last updated on