clearGlobalNotification (クライアント API 参照)

  • [アーティクル]

アプリの通知をクリアします。

構文

Xrm.App.clearGlobalNotification(uniqueId).then(successCallback, errorCallback);

Parameters

件名 タイプ Required Description
uniqueId String はい addGlobalNotification を使用して設定された特定の通知をクリアするために使用する ID。
successCallback Function いいえ 通知がクリアされた場合に呼び出す関数。
errorCallback Function いいえ 処理が失敗したときに呼び出す関数。

戻り値

成功すると、promise オブジェクトを返します。

例

次の例は、通知を追加し、5 秒後に自動的に閉じる方法を示しています。

// define notification object
var notification = 
{
  type: 2,
  level: 3, //warning
  message: "Test warning notification"
}

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);

    // Wait for 5 seconds and then clear the notification
    window.setTimeout(function () { 
            Xrm.App.clearGlobalNotification(result); }, 5000);
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

addGlobalNotification

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。