cancelEvent (Referenční dokumentace rozhraní JavaScript API) pro Dynamics 365 Channel Integration Framework 2.0

Zruší upozornění na příchozí konverzace na základě tokenu zrušení.

Syntaxe

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

Parametry

Název	Typ	Povinné	Description
cancellationToken	String	Ano	Jedinečný řetězec, který byl poskytnut v metodě notifyEvent pro zobrazení oznámení o příchozích konverzacích.
ID korelace	GUID	Ne	Slouží k seskupení všech souvisejících volání rozhraní API pro diagnostickou telemetrii.
úspěchZpětné volání	Funkce	Ne	Funkce, která se má volat v případě úspěchu požadavku. Při úspěšném zpětném volání bude objekt odpovědi obsahovat token zrušení.
errorCallback	Funkce	Ne	Funkce, která se má volat v případě selhání požadavku.

Podrobnosti o funkci zpětného volání

Následující objekty jsou předány do successCallback funkcí a errorCallback .

Funkce successCallback

Vrátí token zrušení.

Funkce errorCallback

Ukázkový objekt JSON:

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

Parametry

zpráva	Description
Chyba RejectAfterClientError	Došlo k neznámé výjimce (nastane v případě, že se nezdaří volání rozhraní API platformy nebo chybí některý vstupní parametr)

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