Dynamics 365 チャネル統合フレームワーク 2.0 の cancelEvent (JavaScript API リファレンス)

キャンセル トークンに基づいて、着信会話に関する通知をキャンセルします。

構文

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

Parameters

件名	タイプ	Required	Description
cancellationToken	String	可	着信会話に関する通知を表示するために notifyEvent メソッドで指定された一意の文字列。
correlationId	GUID	No	診断テレメトリのために関連するすべての API 呼び出しをグループ化するために使用されます。
successCallback	Function	No	要求が成功したときに呼び出す関数。 コールバックが成功すると、応答オブジェクトにはキャンセル トークンが含まれます。
errorCallback	Function	No	要求が失敗したときに呼び出す関数。

コールバック関数の詳細

次のオブジェクトは successCallback 関数と errorCallback 関数に渡されます。

successCallback 関数

キャンセル トークンを返します。

errorCallback 関数

JSON オブジェクトのサンプル:

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

パラメーター

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