cancelEvent (Referência da API JavaScript) para Dynamics 365 Channel Integration Framework 2.0

Cancela a notificação sobre conversas de entrada com base no token de cancelamento.

Sintaxe

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

Parâmetros

Nome	Tipo	Obrigatório	Description
cancellationToken	Cordão	Yes	Cadeia de caracteres exclusiva que foi fornecida no notifyEvent método para exibir notificações sobre conversas de entrada.
correlationId	GUID	Não	Usado para agrupar todas as chamadas de API relacionadas para telemetria de diagnóstico.
successCallback	Função	Não	Uma função a ser chamada quando a solicitação for bem-sucedida. No retorno de chamada bem-sucedido, o objeto de resposta conterá o token de cancelamento.
errorCallback	Função	Não	Uma função para chamar quando a solicitação falhar.

Detalhes da função de retorno de chamada

Os seguintes objetos são passados para as successCallback funções e errorCallback .

função successCallback

Devolve o token de cancelamento.

função errorCallback

Exemplo de objeto JSON:

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

Parâmetros

mensagem	Description
RejectAfterClientError	Ocorreu uma exceção desconhecida (ocorre quando a chamada à API da plataforma falha ou algum parâmetro de entrada está ausente)

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