Udostępnij przez

addGlobalNotification (dokumentacja interfejsu API klienta)

Wyświetla błąd, informacje, ostrzeżenie lub powiadomienie o powodzeniu dla aplikacji i umożliwia określenie akcji do wykonania na podstawie powiadomienia.

Składnia

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

Parametry

Name Typ Wymagane Description
notification Object Tak Powiadomienie do dodania. Zobacz parametr powiadomienia
successCallback Funkcja Nie. Funkcja do wywoływania po wyświetleniu powiadomienia. Wartość identyfikatora GUID jest przekazywana w celu unikatowego zidentyfikowania powiadomienia. Możesz użyć wartości identyfikatora GUID, aby zamknąć lub odrzucić powiadomienie przy użyciu metody clearGlobalNotification.
errorCallback Funkcja Nie. Funkcja wywoływana, gdy operacja zakończy się niepowodzeniem.

właściwość notification

Obiekt zawiera następujące właściwości:

Majątek Typ Wymagane Description
action Object Nie. Obiekt o następujących właściwościach:
- actionLabel(Opcjonalnie) Struna. Etykieta akcji w komunikacie.
- eventHandler: (Opcjonalnie) Odwołanie do funkcji. Funkcja do wykonania po kliknięciu etykiety akcji.
level Number Tak Definiuje poziom powiadomień. Prawidłowe wartości to:
1: Powodzenie
2: Błąd
3: Ostrzeżenie
4: Informacje
message Sznurek Tak Komunikat do wyświetlenia w powiadomieniu.
showCloseButton bool Nie. Wskazuje, czy użytkownik może zamknąć lub odrzucić powiadomienie. Jeśli nie określisz tego parametru, użytkownicy nie będą mogli domyślnie zamknąć ani odrzucić powiadomienia.
type Number Tak Definiuje typ powiadomienia. Obecnie obsługiwana jest tylko wartość 2, która wyświetla pasek komunikatów w górnej części aplikacji.

Wartość zwracana

W przypadku powodzenia zwraca obiekt obietnicy zawierający wartość identyfikatora GUID, aby jednoznacznie zidentyfikować powiadomienie zgodnie z opisem parametru successCallback .

Przykłady

Wyświetlanie powiadomienia o błędzie, którego nie można zamknąć ani odrzucić przez użytkownika

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

W ten sposób powiadomienie o błędzie będzie wyświetlane w aplikacji:

Przykładowe powiadomienie o błędzie.

Wyświetlanie powiadomienia ostrzegawczego, które można zamknąć lub odrzucić przez użytkownika

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

W ten sposób powiadomienie ostrzegawcze będzie wyświetlane w aplikacji:

Przykładowe powiadomienie ostrzegawcze. 

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

W ten sposób powiadomienie o informacjach będzie wyświetlane w aplikacji:

Przykładowe powiadomienie o informacjach.

clearGlobalNotification

  • Last updated on