Поделиться через


cancelEvent (справочник по API JavaScript) для Dynamics 365 Channel Integration Framework 2.0

Отменяет уведомление о входящих беседах на основе токена отмены.

Синтаксис

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

Параметры

Имя Тип Обязательно Description
cancellationToken String Да Уникальная строка, которая была предоставлена в методе notifyEvent для отображения уведомлений о входящих разговорах.
correlationId ГУИД нет Используется для группировки всех связанных вызовов API для диагностической телеметрии.
successОбратный звонок Функция нет Функция, вызываемая при успешном выполнении запроса. При успешном обратном вызове объект ответа будет содержать токен отмены.
errorCallback Функция нет Функция, которая вызывается в случае сбоя запроса.

Детали функции обратного вызова

Следующие объекты передаются в функции and successCallbackerrorCallback .

Функция successCallback

Возвращает токен отмены.

Функция errorCallback

Пример объекта JSON:

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

Параметры

сообщение Description
RejectAfterClientError Произошло неизвестное исключение (возникает при сбое вызова API платформы или отсутствии какого-либо входного параметра)

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
                }
);