Compartir vía

clearGlobalNotification (referencia de la API de cliente)

  • Artículo

Borra una notificación en la aplicación.

Sintaxis

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

Parámetros

Nombre. Type Obligatorio Description
uniqueId String Sí El identificador que se usará para borrar una notificación específica establecida mediante addGlobalNotification.
successCallback Function No Una función para llamar cuando se borra la notificación.
errorCallback Function No Una función a la que se llama cuando la operación tiene error.

Valor devuelto

En caso de éxito, devuelve un objeto de promesa.

Ejemplos

El siguiente ejemplo muestra cómo agregar una notificación y luego cerrarla automáticamente después de 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