cancelEvent (Référence API JavaScript) pour l’environnement d’intégration du canal de Dynamics 365 2.0

Annule la notification concernant les conversations entrantes en fonction du jeton d’annulation.

Syntaxe

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

Paramètres

Nom	Type	Requise	Description
cancellationToken	String	Oui	Chaîne unique fournie dans la notifyEvent méthode pour afficher les notifications sur les conversations entrantes.
correlationId	GUID	Non	Utilisé pour regrouper tous les appels d’API associés pour la télémétrie de diagnostic.
successCallback	Function	Non	Fonction à appeler lorsque la demande aboutit. En cas de rappel réussi, l’objet de réponse contiendra le jeton d’annulation.
errorCallback	Function	Non	Fonction à appeler lorsque la requête échoue.

Détails de la fonction de rappel

Les objets suivants sont passés dans les fonctions successCallback et errorCallback .

Fonction successCallback

Renvoie le jeton d’annulation.

Fonction errorCallback

Exemple d’objet JSON :

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

Paramètres

message	Description
RejectAfterClientError	Une exception inconnue s’est produite (se produit lorsque l’appel de l’API Platform échoue ou qu’un paramètre d’entrée est manquant)

Exemple

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