Partilhar via


clearGlobalNotification (referência da API do cliente)

Limpa uma notificação no aplicativo.

Sintaxe

Xrm.App.clearGlobalNotification(uniqueId).then(successCallback, errorCallback);

Parâmetros

Nome Tipo Obrigatório Description
uniqueId String Yes A ID a ser usada para limpar uma notificação específica que foi definida usando addGlobalNotification.
successCallback Função Não Uma função a ser chamada quando a notificação é desmarcada.
errorCallback Função Não Uma função para chamar quando a operação falhar.

Valor de retorno

Quando for bem-sucedido, retorna um objeto promise.

Examples

O exemplo a seguir mostra como adicionar uma notificação e fechá-la automaticamente após 5 segundos.

// define notification object
var notification = 
{
  type: 2,
  level: 3, //warning
  message: "Test warning notification"
}

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);

    // Wait for 5 seconds and then clear the notification
    window.setTimeout(function () { 
            Xrm.App.clearGlobalNotification(result); }, 5000);
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

addGlobalNotification