addGlobalNotification (ügyfél API-referencia)

Hibaüzenetet, információt, figyelmeztetést vagy sikerértesítést jelenít meg egy alkalmazáshoz, és lehetővé teszi az értesítés alapján végrehajtandó műveletek megadását.

Szemantika

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

Paraméterek

Név Típus Kötelező Description
notification Objektum Igen A hozzáadni kívánt értesítés. Értesítési paraméter megtekintése
successCallback Funkció Nem Az értesítés megjelenésekor meghívandó függvény. A guid érték az értesítés egyedi azonosításához lesz átadva. A GUID érték használatával bezárhatja vagy elvetheti az értesítést a clearGlobalNotification metódussal.
errorCallback Funkció Nem A művelet sikertelensége esetén meghívandó függvény.

notification tulajdonság

Az objektum a következő tulajdonságokat tartalmazza:

Ingatlan Típus Kötelező Description
action Objektum Nem Egy objektum a következő tulajdonságokkal:
- actionLabel(Nem kötelező) Húr. Az üzenetben szereplő művelet címkéje.
- eventHandler: (Nem kötelező) Függvényhivatkozás. A műveletcímke kattintáskor végrehajtandó függvény.
level Szám Igen Meghatározza az értesítés szintjét. Az érvényes értékek a következők:
1: Siker
2: Hiba
3: Figyelmeztetés
4: Információ
message Lánc Igen Az értesítésben megjelenítendő üzenet.
showCloseButton Boole Nem Azt jelzi, hogy a felhasználó bezárhatja vagy elutasíthatja-e az értesítést. Ha nem adja meg ezt a paramétert, a felhasználók alapértelmezés szerint nem zárhatják be vagy zárhatják le az értesítést.
type Szám Igen Meghatározza az értesítés típusát. Jelenleg csak a 2 érték támogatott, amely egy üzenetsávot jelenít meg az alkalmazás tetején.

Visszaadott érték

Sikeresség esetén egy GUID értéket tartalmazó ígéretobjektumot ad vissza, amely egyedileg azonosítja az értesítést a successCallback paraméter leírásában korábban leírtak szerint.

Példák

Hibaértesítés megjelenítése, amelyet a felhasználó nem zárhat be vagy zárhat ki

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

Így jelenik meg a hibaértesítés az alkalmazásban:

Példa hibaértesítésre.

A felhasználó által bezárható vagy elutasítható figyelmeztető értesítés megjelenítése

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

Így jelenik meg a figyelmeztető értesítés az alkalmazásban:

Figyelmeztetési példa.

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

Így jelenik meg az értesítés az alkalmazásban:

Példainformációs értesítés.

clearGlobalNotification