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

Відображає повідомлення про помилку, відомості, попередження або сповіщення про успіх для програми та дає змогу вказати дії, які виконуватимуться на основі сповіщення.

Синтаксис

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

Параметри

Ім'я	Ввести	Необхідний	Опис
notification	Об'єкт	Так	Сповіщення для додавання. Переглянути параметр сповіщення
successCallback	Function	Ні	Функція для виклику під час відображення сповіщення. Значення GUID передається для унікальної ідентифікації сповіщення. За допомогою значення GUID можна закрити або закрити сповіщення за допомогою методу clearGlobalNotification.
errorCallback	Function	Ні	Функція для виклику, коли операція не вдається.

властивість сповіщень

Об'єкт містить такі властивості:

Власність	Ввести	Необхідний	Опис
action	Об'єкт	Ні	Об'єкт із такими властивостями: - actionLabel(Необов'язково) Рядок. Підпис дії в повідомленні. - eventHandler: (Необов'язковий) посилання на функцію. Функція, яка виконується після натискання підпису дії.
level	Число	Так	Визначає рівень сповіщення. Допустимими значеннями є: 1: Успіх 2. Помилка 3: Попередження 4: Інформація
message	String	Так	Повідомлення, що відображатиметься в сповіщенні.
showCloseButton	Bool (Логічне значення)	Ні	Указує, чи може користувач закрити або закрити сповіщення. Якщо не вказати цей параметр, користувачі не зможуть закрити або закрити сповіщення за замовчуванням.
type	Число	Так	Визначає тип сповіщення. Наразі підтримується лише значення 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