addGlobalNotification (kliento API nuoroda)

Rodo programos klaidą, informaciją, įspėjimą arba pranešimą apie sėkmę ir leidžia nurodyti veiksmus, kuriuos reikia vykdyti pagal pranešimą.

Sintaksė

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

Parametrus

Pavadinimą	Rūšis	Privalomas	Aprašą
notification	Daiktas	Taip	Pranešimas, kurį norite įtraukti. Žr . pranešimo parametrą
successCallback	Funkcija	Ne	Funkcija, iškviečiama, kai rodomas pranešimas. GUID reikšmė perduodama unikaliai identifikuoti pranešimą. Galite naudoti GUID reikšmę, kad uždarytumėte arba atmestumėte pranešimą naudodami "clearGlobalNotification" metodą.
errorCallback	Funkcija	Ne	Funkcija, kurią reikia iškviesti, kai operacija nepavyksta.

pranešimų ypatybė

Objekte yra šios ypatybės:

Nuosavybė	Rūšis	Privalomas	Aprašą
action	Daiktas	Ne	Objektas su šiomis ypatybėmis: - actionLabel(Pasirinktinai) Eilutės. Pranešimo veiksmo žyma. - eventHandler: (Pasirinktinai) Funkcijos nuoroda. Funkcija, vykdoma spustelėjus veiksmo žymą.
level	Skaičius	Taip	Apibrėžia pranešimo lygį. Leistinos reikšmės: 1: Sėkmė 2: klaida 3: įspėjimas 4: Informacija
message	String	Taip	Pranešimas, rodomas pranešime.
showCloseButton	Bulio logika	Ne	Nurodo, ar vartotojas gali uždaryti arba atmesti pranešimą. Jei nenurodysite šio parametro, pagal numatytuosius parametrus vartotojai negalės uždaryti arba atmesti pranešimo.
type	Skaičius	Taip	Apibrėžia pranešimo tipą. Šiuo metu palaikoma tik 2 reikšmė, kuri programos viršuje rodo pranešimų juostą.

Grąžinimo reikšmė

Sėkmingai, pateikia pažado objektą, kuriame yra GUID reikšmė, unikaliai identifikuojanti pranešimą, kaip aprašyta anksčiau successCallback parametro apraše.

Pavyzdžiai

Rodyti klaidos pranešimą, kurio vartotojas negali uždaryti arba atmesti

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

Štai kaip klaidos pranešimas bus rodomas taikomojoje programoje:

Rodyti įspėjimo pranešimą, kurį vartotojas gali uždaryti arba atmesti

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

Štai kaip įspėjimo pranešimas bus rodomas programėlėje:

Rodyti informacijos pranešimą su saitu "Sužinokite daugiau", kurį gali spustelėti vartotojai

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

Taip programėlėje bus rodomas informacinis pranešimas:

Susiję straipsniai

clearGlobalNotification