addGlobalNotification (reference k rozhraní API klienta)

Zobrazí chybu, informace, upozornění nebo oznámení o úspěchu aplikace a umožňuje zadat akce, které se mají provést na základě oznámení.

Syntaxe

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

Parametry

Název Typ Povinné Description
notification Object Ano Oznámení, které chcete přidat. Zobrazit parametr oznámení
successCallback Funkce Ne Funkce, která se má volat při zobrazení oznámení. Hodnota GUID se předává k jedinečné identifikaci oznámení. Hodnotu GUID můžete použít k zavření nebo zavření oznámení pomocí metody clearGlobalNotification.
errorCallback Funkce Ne Funkce, která se má volat v případě selhání operace.

vlastnost oznámení

Objekt obsahuje následující vlastnosti:

Vlastnictví Typ Povinné Description
action Object Ne Objekt s následujícími vlastnostmi:
- actionLabel(Volitelné) Řetězec. Popisek akce ve zprávě
- eventHandler: (Volitelné) Odkaz na funkci. Funkce, která se má provést po kliknutí na popisek akce.
level Number Ano Definuje úroveň oznámení. Platné hodnoty jsou:
1: Úspěch
2: Chyba
3: Upozornění
4: Informace
message String Ano Zpráva, která se má zobrazit v oznámení
showCloseButton Booleovská hodnota Ne Určuje, jestli uživatel může oznámení zavřít nebo zavřít. Pokud tento parametr nezadáte, uživatelé nemůžou oznámení ve výchozím nastavení zavřít nebo zavřít.
type Number Ano Definuje typ oznámení. V současné době se podporuje jenom hodnota 2, která zobrazuje panel zpráv v horní části aplikace.

Návratová hodnota

Při úspěchu vrátí objekt příslibu obsahující hodnotu GUID jedinečně identifikovat oznámení, jak je popsáno výše v popisu parametru successCallback .

Examples

Zobrazení oznámení o chybě, které uživatel nemůže zavřít nebo zavřít

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

Tímto způsobem se v aplikaci zobrazí oznámení o chybě:

Příklad oznámení o chybě

Zobrazení upozornění, které může uživatel zavřít nebo zavřít

// 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 se v aplikaci zobrazí upozornění:

Příklad upozornění.

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

Tímto způsobem se v aplikaci zobrazí oznámení o informacích:

Příklad oznámení o informacích

clearGlobalNotification