addGlobalNotification (Клиент API анықтамасы)

Бағдарлама үшін қате, ақпарат, ескерту немесе сәттілік туралы хабарландыруды көрсетеді және хабарландыру негізінде орындалатын әрекеттерді көрсетуге мүмкіндік береді.

Синтаксис

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

Параметрлер

РаT� РаT� Талап етіледі Сипаттама
notification Нысан Иә Қосу туралы хабарландыру. Хабарландыру параметрін қараңыз
successCallback Function Жоқ Хабарландыру көрсетілген кезде қоңырау шалу функциясы. Хабарландыруды бірегей анықтау үшін GUID мәні беріледі. clearGlobalNotification әдісін пайдаланып хабарландыруды жабу немесе жою үшін GUID мәнін пайдалануға болады.
errorCallback Function Жоқ Операция істен шыққанда қоңырау шалу функциясы.

Хабарландыру сипаты

Объект келесі қасиеттерді қамтиды:

РаT� РаT� Талап етіледі Сипаттама
action Нысан Жоқ Келесі қасиеттері бар нысан:
- actionLabel(Қосымша) Жол. Хабардағы әрекеттің белгісі.
- eventHandler: (Қосымша) Функция сілтемесі. Әрекет белгісін басқанда орындалатын функция.
level Саны Иә Хабарландыру деңгейін анықтаңыз. Жарамды мәндер:
1: Сәттілік
2: Қате
3: Ескерту
4: Ақпарат
message String Иә Хабарландыруда көрсетілетін хабар.
showCloseButton Буль Жоқ Пайдаланушының хабарландыруды жабуға немесе жоюға болатындығын көрсетеді. Егер бұл параметрді көрсетпесеңіз, пайдаланушылар әдепкі бойынша хабарландыруды жаба немесе жоққа шығара алмайды.
type Саны Иә Хабарлама түрін анықтаңыз. Қазіргі уақытта қолданбаның жоғарғы жағында хабарлама жолағын көрсететін 2 мәніне ғана қолдау көрсетіледі.

Қайтаратын мән

Сәтті болған жағдайда, successCallback параметрінің сипаттамасында жоғарыда сипатталғандай, хабарландыруды бірегей анықтау үшін GUID мәнін қамтитын уәде нысаны қайтарады.

Мысалдар

Пайдаланушы жаба немесе жоққа шығара алмайтын қате туралы хабарландыруды көрсету

// 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