addGlobalNotification (odkaz na klientske rozhranie API)

Zobrazí chybu, informácie, upozornenie alebo oznámenie o úspešnom vykonaní pre aplikáciu a umožňuje určiť akcie, ktoré sa majú vykonať na základe oznámenia.

Syntax

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

Parametre

Meno	Typ	Požaduje sa	Popis
notification	Object	Áno	Oznámenie, ktoré sa má pridať. Pozrite si parameter oznámenia
successCallback	Function	Nie	Funkcia, ktorá sa zavolá pri zobrazení oznámenia. Na jedinečnú identifikáciu oznámenia sa odovzdáva hodnota GUID. Hodnotu GUID môžete použiť na zatvorenie alebo zrušenie oznámenia pomocou metódy clearGlobalNotification.
errorCallback	Function	Nie	Funkcia, ktorá sa volá v prípade zlyhania operácie.

vlastnosť notification

Objekt obsahuje nasledujúce vlastnosti:

Majetok	Typ	Požaduje sa	Popis
action	Object	Nie	Objekt s nasledujúcimi vlastnosťami: - actionLabel(Voliteľné) Povrázok. Označenie akcie v správe. - eventHandler: (Voliteľné) Odkaz na funkciu. Funkcia, ktorá sa vykoná po kliknutí na označenie akcie.
level	Číslo	Áno	Definuje úroveň oznámenia. Platné hodnoty sú: 1: Úspech 2: Chyba 3: Upozornenie 4: Informácie
message	String	Áno	Správa, ktorá sa zobrazí v oznámení.
showCloseButton	Bool	Nie	Udáva, či používateľ môže oznámenie zavrieť alebo zrušiť. Ak tento parameter nezadáte, používatelia predvolene nemôžu oznámenie zavrieť ani zrušiť.
type	Číslo	Áno	Definuje typ oznámenia. V súčasnosti je podporovaná len hodnota 2, čo zobrazuje panel správ v hornej časti aplikácie.

Vrátená hodnota

Po úspešnom dokončení vráti objekt sľubu obsahujúci hodnotu GUID, ktorý jednoznačne identifikuje oznámenie, ako je to popísané vyššie v popise parametra successCallback .

Príklady

Zobrazenie oznámenia o chybe, ktoré používateľ nemôže zavrieť alebo zrušiť

// 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
    }
);

Takto sa zobrazí oznámenie o chybe v aplikácii:

Zobrazí upozornenie, ktoré používateľ môže zavrieť alebo zrušiť

// 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
    }
);

Takto sa v aplikácii zobrazí upozornenie:

Zobrazí informačné oznámenie s prepojením Ďalšie informácie, na ktoré môžu kliknúť používatelia

// 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
    }
);

Takto sa informačné oznámenie zobrazí v aplikácii:

Súvisiace články

clearGlobalNotification