addGlobalNotification (Referencia da API do cliente)

Mostra unha notificación de erro, información, advertencia ou éxito para unha aplicación e permítelle especificar as accións a executar en función da notificación.

Sintaxe

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

Parámetros

Nome	Tipo	Obrigatorio	Descrición
notification	Obxecto	Si	A notificación a engadir. Vexa o parámetro de notificación
successCallback	Function	Non	Función para chamar cando se mostra a notificación. Pasa un valor GUID para identificar de forma única a notificación. Pode usar o valor GUID para pechar ou descartar a notificación usando o método clearGlobalNotification.
errorCallback	Function	Non	Unha función a chamar cando a operación falla.

Propiedade de notificación

O obxecto contén as seguintes propiedades:

Propiedade	Tipo	Obrigatorio	Descrición
action	Obxecto	Non	Obxecto coas seguintes propiedades: - actionLabel(Opcional) Corda. Etiqueta da acción na mensaxe. - eventHandler: (Opcional) Referencia da función. A función a executar cando se fai clic na etiqueta de acción.
level	Número	Si	Define o nivel de notificación. Os valores válidos son: 1: Éxito 2: Erro 3: Advertencia 4: Información
message	String	Si	A mensaxe que se mostrará na notificación.
showCloseButton	Bool	Non	Indica se o usuario pode pechar ou descartar a notificación. Se non especifica este parámetro, os usuarios non poderán pechar ou descartar a notificación por defecto.
type	Número	Si	Define o tipo de notificación. Actualmente, só se admite un valor de 2, que mostra unha barra de mensaxes na parte superior da aplicación.

Devolver valor

En caso de éxito, devolve un obxecto de promesa que contén un valor GUID para identificar de forma única a notificación, tal e como se describiu anteriormente na descrición do parámetro successCallback .

Exemplos

Mostrar unha notificación de erro que non pode ser pechada ou descartada polo usuario

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

Así aparecerá a notificación de erro na aplicación:

Mostrar unha notificación de advertencia que pode ser pechada ou descartada polo usuario

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

Así aparecerá a notificación de aviso na aplicación:

Mostrar unha notificación informativa cunha ligazón "Saber máis" na que os usuarios poden facer clic

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

Así aparecerá a notificación informativa na aplicación:

Artigos relacionados

clearGlobalNotification