Udostępnij przez

cancelEvent (dokumentacja interfejsu API JavaScript) dla Dynamics 365 Channel Integration Framework 2.0

Anuluje powiadomienie o przychodzących konwersacjach na podstawie tokenu anulowania.

Składnia

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

Parametry

Name Typ Wymagane Description
Token anulowania Sznurek Tak Unikatowy ciąg znaków, który został podany w metodzie notifyEvent wyświetlania powiadomień o przychodzących rozmowach.
correlationId (identyfikator korelacji) GUID Nie. Służy do grupowania wszystkich powiązanych wywołań interfejsu API na potrzeby telemetrii diagnostycznej.
successCallback (pomyślne wywołanie zwrotne) Funkcja Nie. Funkcja do wywołania, gdy żądanie zakończy się pomyślnie. Po pomyślnym wywołaniu zwrotnym obiekt odpowiedzi będzie zawierał token anulowania.
errorOddzwanianie Funkcja Nie. Funkcja do wywołania, gdy żądanie zakończy się niepowodzeniem.

Szczegóły funkcji wywołania zwrotnego

Następujące obiekty są przekazywane do funkcji and successCallbackerrorCallback .

successCallback, funkcja

Zwraca token anulowania.

errorCallback, funkcja

Przykładowy obiekt JSON:

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

Parametry

komunikat Description
RejectAfterClientError (Odrzuć błąd klienta) Wystąpił nieznany wyjątek (występuje, gdy wywołanie interfejsu API platformy kończy się niepowodzeniem lub brakuje jakiegoś parametru wejściowego)

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