addGlobalNotification (referință API client)

Afișează o eroare, informații, avertismente sau notificări de succes pentru o aplicație și vă permite să specificați acțiunile de executat pe baza notificării.

Sintaxă

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

Parametri

Nume Tipul Obligatoriu Descriere
notification Obiect Da Notificarea de adăugat. Vedeți parametrul de notificare
successCallback Funcţie No O funcție de apelat atunci când se afișează notificarea. O valoare GUID este transmisă pentru a identifica în mod unic notificarea. Puteți utiliza valoarea GUID pentru a închide sau a închide notificarea utilizând metoda clearGlobalNotification.
errorCallback Funcţie No O funcție de apelat atunci când operațiunea eșuează.

proprietatea de notificare

Obiectul conține următoarele proprietăți:

Proprietate Tipul Obligatoriu Descriere
action Obiect No Un obiect cu următoarele proprietăți:
- actionLabel(Opțional) Șir. Eticheta acțiunii din mesaj.
- eventHandler: (Opțional) Referință funcție. Funcția de executat atunci când se face clic pe eticheta de acțiune.
level Număr Da Definește nivelul de notificare. Valorile valide sunt:
1: Succes
2: Eroare
3: Avertisment
4: Informații
message Șir Da Mesajul de afișat în notificare.
showCloseButton Bool No Indică dacă utilizatorul poate închide sau închide notificarea. Dacă nu specificați acest parametru, utilizatorii nu pot închide sau respinge notificarea în mod implicit.
type Număr Da Definește tipul de notificare. În prezent, este acceptată doar o valoare de 2, care afișează o bară de mesaje în partea de sus a aplicației.

Valoarea returnată

La succes, returnează un obiect promisiune care conține o valoare GUID pentru a identifica în mod unic notificarea așa cum este descris anterior în descrierea parametrului successCallback .

Exemple

Afișarea unei notificări de eroare care nu poate fi închisă sau respinsă de utilizator

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

Iată cum va apărea notificarea de eroare în aplicație:

Exemplu de notificare de eroare.

Afișarea unei notificări de avertizare care poate fi închisă sau respinsă de utilizator

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

Iată cum va apărea notificarea de avertizare în aplicație:

Exemplu de notificare de avertizare.

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

Iată cum va apărea notificarea cu informațiile în aplicație:

Exemplu de notificare cu informații.

clearGlobalNotification