cancelEvent (referencia de API JavaScript) para Marco de integración de canal de Dynamics 365 2.0

Cancela la notificación sobre conversaciones entrantes según el símbolo (token) de cancelación.

Sintaxis

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

Parámetros

Name	Type	Obligatorio	Descripción
cancellationToken	String	Sí	Cadena única que se proporcionó en el método notifyEvent para mostrar notificaciones sobre conversaciones entrantes.
correlationId	GUID	No	Se usa para agrupar todas las llamadas API relacionadas para telemetría de diagnóstico.
successCallback	Function	No	Una función para llamar cuando la solicitud se realiza correctamente. En caso de una devolución de llamada correcta, el objeto de respuesta contendrá el símbolo (token) de cancelación.
errorCallback	Function	No	Una función para llamar cuando la solicitud produce error.

Detalles de la función de devolución de llamada

Los siguientes objetos se pasan a las funciones successCallback y errorCallback.

Función successCallback

Devuelve el símbolo (token) de cancelación.

Función errorCallback

Objeto JSON de ejemplo:

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

Parámetros

message	Descripción
RejectAfterClientError	Se produjo una excepción desconocida (ocurre cuando falla la llamada a la API de la plataforma o falta algún parámetro de entrada)

Ejemplo

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