addGlobalNotification (referência da API do cliente)

Exibe uma notificação de erro, informação, aviso ou êxito para um aplicativo e permite especificar ações a serem executadas com base na notificação.

Sintaxe

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

Parâmetros

Nome	Tipo	Obrigatório	Description
notification	Objeto	Yes	A notificação a adicionar. Ver parâmetro de notificação
successCallback	Função	Não	Uma função para chamar quando a notificação é exibida. Um valor GUID é passado para identificar exclusivamente a notificação. Você pode usar o valor GUID para fechar ou descartar a notificação usando o método clearGlobalNotification.
errorCallback	Função	Não	Uma função para chamar quando a operação falhar.

Propriedade de notificação

O objeto contém as seguintes propriedades:

Propriedade	Tipo	Obrigatório	Description
action	Objeto	Não	Um objeto com as seguintes propriedades: - actionLabel(Opcional) String. O rótulo da ação na mensagem. - eventHandler: (Opcional) Referência da função. A função a ser executada quando o rótulo da ação é clicado.
level	Número	Yes	Define o nível de notificação. Os valores válidos são: 1: Sucesso 2: Erro 3: Advertência 4: Informação
message	Corda	Yes	A mensagem a ser exibida na notificação.
showCloseButton	Bool	Não	Indica se o usuário pode ou não fechar ou descartar a notificação. Se você não especificar esse parâmetro, os usuários não poderão fechar ou descartar a notificação por padrão.
type	Número	Yes	Define o tipo de notificação. Atualmente, apenas um valor de 2 é suportado, que exibe uma barra de mensagens na parte superior do aplicativo.

Valor de retorno

Quando for bem-sucedido, retorna um objeto promise contendo um valor GUID para identificar exclusivamente a notificação, conforme descrito anteriormente na descrição do parâmetro successCallback .

Examples

Exibir uma notificação de erro que não pode ser fechada ou descartada pelo usuário

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

É assim que a notificação de erro aparecerá no aplicativo:

Exibir uma notificação de aviso que pode ser fechada ou descartada pelo usuário

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

É assim que a notificação de aviso aparecerá no aplicativo:

Exibir uma notificação de informações com um link "Saiba mais" que pode ser clicado pelos usuários

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

É assim que a notificação de informações aparecerá no aplicativo:

Artigos relacionados

clearGlobalNotification