addGlobalNotification (klienta API atsauce)

Parāda programmas kļūdu, informāciju, brīdinājumu vai paziņojumu par panākumiem un ļauj norādīt darbības, kas jāizpilda, pamatojoties uz paziņojumu.

Sintakse

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

Parameters

Vārds	Tips	Obligāti	Apraksts
notification	Objektu	Jā	Paziņojums par pievienošanu. Skatīt paziņojuma parametru
successCallback	Function	Nē	Funkcija, kas jāizsauc, kad tiek parādīts paziņojums. Tiek nodota GUID vērtība, lai unikāli identificētu paziņojumu. Varat izmantot GUID vērtību, lai aizvērtu vai noraidītu paziņojumu, izmantojot metodi clearGlobalNotification.
errorCallback	Function	Nē	Funkcija, kas jāizsauc, ja operācija neizdodas.

Paziņojuma rekvizīts

Objekts satur šādus rekvizītus:

Īpašums	Tips	Obligāti	Apraksts
action	Objektu	Nē	Objekts ar šādiem rekvizītiem: - actionLabel(Pēc izvēles) Virkne. Ziņojumā norādītās darbības etiķete. - eventHandler: (Neobligāti) Atsauce uz funkciju. Funkcija, kas jāizpilda, noklikšķinot uz darbības etiķetes.
level	Numurs	Jā	Definē paziņošanas līmeni. Derīgās vērtības ir: 1: Panākumi 2: Kļūda 3: Brīdinājums 4: Informācija
message	String	Jā	Ziņojums, kas jāparāda paziņojumā.
showCloseButton	Būls	Nē	Norāda, vai lietotājs var aizvērt vai noraidīt paziņojumu. Ja nenorādāt šo parametru, lietotāji pēc noklusējuma nevar aizvērt vai noraidīt paziņojumu.
type	Numurs	Jā	Definē paziņojuma veidu. Pašlaik tiek atbalstīta tikai vērtība 2, kas programmas augšdaļā parāda ziņojumu joslu.

Atgrieztā vērtība

Ja tas ir veiksmīgs, atgriež solījuma objektu, kas satur GUID vērtību, lai unikāli identificētu paziņojumu, kā aprakstīts iepriekš parametra successCallback aprakstā.

Piemēri

Parāda kļūdas paziņojumu, kuru lietotājs nevar aizvērt vai noraidī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
    }
);

Šādi lietotnē parādīsies kļūdas paziņojums:

Parādīt brīdinājuma paziņojumu, kuru lietotājs var aizvērt vai noraidī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
    }
);

Šādi brīdinājuma paziņojums parādīsies lietotnē:

Parādiet informatīvu paziņojumu ar saiti "Uzzināt vairāk", uz kuras lietotāji var noklikšķināt

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

Informatīvais paziņojums lietotnē parādīsies šādi:

Saistītie raksti

clearGlobalNotification