Compartilhar via

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 String 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.
sucessoRetorno de chamada Função Não Uma função a ser chamada quando a solicitação for bem-sucedida. Em caso de retorno de chamada bem-sucedido, o objeto de resposta conterá o token de cancelamento.
erroRetorno de chamada Função Não Uma função a ser chamada quando a solicitação falhar.

Detalhes da função de retorno de chamada

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

Função successCallback

Retorna o token de cancelamento.

errorFunção de retorno de chamada

Exemplo de objeto JSON:

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

Parâmetros

mensagem Description
RejectAfterClientError Ocorreu uma exceção desconhecida (ocorre quando a chamada da 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
                }
);
  • Last updated on