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

Отображает уведомление об ошибке, информации, предупреждении или успешном выполнении для приложения и позволяет указать действия, выполняемые на основе уведомления.

Синтаксис

Xrm.App.addGlobalNotification(notification).then(successCallback, errorCallback);

Параметры

Имя	Тип	Обязательно	Description
notification	Object	Да	Уведомление для добавления. См . параметр уведомления
successCallback	Функция	нет	Функция для вызова при отображении уведомления. Значение GUID передается для уникальной идентификации уведомления. Значение GUID можно использовать для закрытия или закрытия уведомления с помощью метода clearGlobalNotification.
errorCallback	Функция	нет	Функция, вызываемая при сбое операции.

Свойство уведомления

Объект содержит следующие свойства:

Недвижимость	Тип	Обязательно	Description
action	Object	нет	Объект со следующими свойствами: - actionLabel(Необязательно) Струна. Метка действия в сообщении. - eventHandler: (Необязательно) Ссылка на функцию. Функция, выполняемая при щелчке метки действия.
level	Number	Да	Определяет уровень уведомлений. Допустимые значения: 1. Успех 2. Ошибка 3. Предупреждение 4. Сведения
message	String	Да	Сообщение, отображаемое в уведомлении.
showCloseButton	Булев	нет	Указывает, может ли пользователь закрыть или закрыть уведомление. Если этот параметр не указан, пользователи по умолчанию не смогут закрыть или закрыть уведомление.
type	Number	Да	Определяет тип уведомления. В настоящее время поддерживается только значение 2, которое отображает панель сообщений в верхней части приложения.

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

При успешном выполнении возвращает объект обещания, содержащий значение GUID для уникального определения уведомления, как описано ранее в описании параметра successCallback .

Примеры

Отображение уведомления об ошибке, которое невозможно закрыть или закрыть пользователем

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

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);
        // perform other operations as required on notification display
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Вот как появится уведомление об ошибке в приложении:

Отображение уведомления о предупреждении, которое может быть закрыто или отклонено пользователем

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

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);
        // perform other operations as required on notification display
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Вот как в приложении появится уведомление об предупреждении:

Отображение уведомления о информации со ссылкой "Подробнее", которую можно щелкнуть пользователями

// define action object
var myAction =
{
  actionLabel: "Learn more", 
  eventHandler: function () {
        Xrm.Navigation.openUrl("https://learn.microsoft.com/powerapps/");
        // perform other operations as required on clicking
    }
}

// define notification object
var notification = 
{
  type: 2,
  level: 4, // information
  message: "Test information notification",  
  action: myAction
}

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);
        // perform other operations as required on notification display
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Вот как появится уведомление о информации в приложении:

Связанные статьи

clearGlobalNotification