Поділитися через


clearGlobalNotification (довідник з API клієнта)

Очищує сповіщення в програмі.

Синтаксис

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

Параметри

Ім'я Ввести Обов'язковий Опис
uniqueId String Так Ідентифікатор, який використовується для очищення певного сповіщення, установленого за допомогою addGlobalNotification.
successCallback Function Ні Функція, яка викликається, коли сповіщення знято.
errorCallback Function Ні Функція для виклику, коли операція не вдається.

Повернуте значення

Після успіху повертає об'єкт обіцянки.

Приклади

У наведеному нижче прикладі показано, як додати сповіщення, а потім автоматично закрити його через 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