cancelEvent (αναφορά API JavaScript) για το Dynamics 365 Channel Integration Framework 2.0

Ακυρώνει την ειδοποίηση σχετικά με εισερχόμενες συνομιλίες με βάση το διακριτικό ακύρωσης.

Syntax

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

Parameters

Πλήρες όνομα	Type	Απαραίτητο	Περιγραφή
ακύρωσηToken	String	Όχι	Μοναδική συμβολοσειρά που παρέχεται στη notifyEvent μέθοδο εμφάνισης ειδοποιήσεων σχετικά με εισερχόμενες συνομιλίες.
correlationId	GUID	όχι	Χρησιμοποιείται για την ομαδοποίηση όλων των σχετικών κλήσεων API για διαγνωστική τηλεμετρία.
επιτυχίαΕπανάκληση	Function	όχι	Μια λειτουργία κλήσης όταν η αίτηση είναι επιτυχής. Κατά την επιτυχή επιστροφή κλήσης, το αντικείμενο απόκρισης θα περιέχει το διακριτικό ακύρωσης.
errorCallback	Function	όχι	Μια λειτουργία κλήσης όταν αποτύχει η αίτηση.

Λεπτομέρειες λειτουργίας επιστροφής κλήσης

Τα ακόλουθα αντικείμενα μεταβιβάζονται στις συναρτήσεις and successCallbackerrorCallback .

successCallback (Συνάρτηση successCallback)

Επιστρέφει το διακριτικό ακύρωσης.

errorCallback (Συνάρτηση επιστροφής κλήσης)

Δείγμα αντικειμένου JSON:

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

Παραμέτρους

μήνυμα	Περιγραφή
RejectAfterClientError	Παρουσιάστηκε μια άγνωστη εξαίρεση (εμφανίζεται όταν η κλήση API πλατφόρμας αποτύχει ή λείπει κάποια παράμετρος εισόδου)

Παράδειγμα

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