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	Булева променлива	Не	Показва дали потребителят може да затвори или да отхвърли известието. Ако не зададете този параметър, потребителите не могат да затворят или отхвърлят известието по подразбиране.
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