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


clearGlobalNotification (справочник по API клиента)

Очищает уведомление в приложении.

Синтаксис

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

Параметры

Имя Тип Обязательно Description
uniqueId String Да Идентификатор, используемый для очистки определенного уведомления, заданного с помощью addGlobalNotification.
successCallback Функция нет Функция, вызываемая при очистке уведомления.
errorCallback Функция нет Функция, вызываемая при сбое операции.

Возвращаемое значение

При успешном выполнении возвращает объект 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