Compartilhar via

addGlobalNotification (referência da API do cliente)

Exibe uma notificação de erro, informações, aviso ou êxito para um aplicativo e permite que você especifique 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 Object Yes A notificação a ser adicionada. Consulte o parâmetro de notificação
successCallback Função Não Uma função a ser chamada quando a notificação é exibida. Um valor GUID é passado para identificar exclusivamente a notificação. Você pode usar o valor guid para fechar ou ignorar a notificação usando o método clearGlobalNotification.
errorCallback Função Não Uma função a ser chamada quando a operação falhar.

propriedade notification

O objeto contém as seguintes propriedades:

Propriedade Tipo Obrigatório Description
action Object Não Um objeto com as seguintes propriedades:
- actionLabel(Opcional) Corda. O rótulo da ação na mensagem.
- eventHandler: (Opcional) Referência de 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: Aviso
4: Informações
message String Yes A mensagem a ser exibida na notificação.
showCloseButton Bool Não Indica se o usuário pode ou não fechar ou ignorar a notificação. Se você não especificar esse parâmetro, os usuários não poderão fechar ou ignorar a notificação por padrão.
type Número Yes Define o tipo de notificação. Atualmente, há suporte apenas para um valor de 2, que exibe uma barra de mensagens na parte superior do aplicativo.

Valor de retorno

Com êxito, retorna um objeto de promessa que contém um valor GUID para identificar exclusivamente a notificação, conforme descrito anteriormente na descrição do parâmetro successCallback .

Exemplos

Exibir uma notificação de erro que não pode ser fechada ou ignorada 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 será exibida no aplicativo:

Notificação de erro de exemplo.

Exibir uma notificação de aviso que pode ser fechada ou ignorada 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 será exibida no aplicativo:

Notificação de aviso de exemplo. 

// 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 será exibida no aplicativo:

Notificação de informações de exemplo.

clearGlobalNotification

  • Last updated on