ToastNotifier Clase

Definición

Espacio de nombres:

Windows.UI.Notifications

Genera una notificación del sistema a la aplicación específica a la que está enlazado ToastNotifier. Esta clase también le permite programar y quitar notificaciones del sistema.

public ref class ToastNotifier sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotifier final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ToastNotifier

Public NotInheritable Class ToastNotifier

Herencia

Object Platform::Object IInspectable ToastNotifier

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

En el ejemplo siguiente se muestra cómo crear y enviar una notificación del sistema que incluye texto e imágenes, incluido el uso del método Show .

var notifications = Windows.UI.Notifications;

// Get the toast notification manager for the current app.
var notificationManager = notifications.ToastNotificationManager;

// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object
// that contains the toast notification XML content.
var template = notifications.ToastTemplateType.toastImageAndText01;
var toastXml = notificationManager.getTemplateContent(template);
var template = notifications.toastTemplateType.toastImageAndText01;
var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]);

// You can use the methods from the XML document to specify the required elements for the toast.
var images = toastXml.getElementsByTagName("image");
images[0].setAttribute("src", "images/toastImageAndText.png");

var textNodes = toastXml.getElementsByTagName("text");
textNodes.forEach(function (value, index) {
    var textNumber = index + 1;
    var text = "";
    for (var j = 0; j < 10; j++) {
        text += "Text input " + /*@static_cast(String)*/textNumber + " ";
    }
    value.appendChild(toastXml.createTextNode(text));
});

// Create a toast notification from the XML, then create a ToastNotifier object
// to send the toast.
var toast = new notifications.ToastNotification(toastXml);

notificationManager.createToastNotifier().show(toast);

En el ejemplo siguiente se muestra el uso de los métodos GetScheduledToastNotifications y RemoveFromSchedule .

var notifier = Notifications.ToastNotificationManager.createToastNotifier();
var scheduled = notifier.getScheduledToastNotifications();                    

for (var i = 0, len = scheduled.length; i < len; i++) {

    // The itemId value is the unique ScheduledTileNotification.Id assigned to the 
    // notification when it was created.
    if (scheduled[i].id === itemId) {
        notifier.removeFromSchedule(scheduled[i]);
    }
}

Comentarios

Cuando se crea, ToastNotifier se enlaza a una aplicación específica, por lo que los métodos de esta clase solo afectan a esa aplicación.

Historial de versiones

Versión de Windows	Versión del SDK	Valor agregado
1703	15063	Update(NotificationData,String,String)
1703	15063	Update(NotificationData,String)
1809	17763	ScheduledToastNotificationShowing

Propiedades

Setting

Obtiene un valor que indica si hay una aplicación, un usuario o un bloque del sistema que impide la presentación de una notificación del sistema.

Métodos

AddToSchedule(ScheduledToastNotification)	Agrega una ScheduledToastNotification para mostrarla más adelante por Windows. Importante Este método solo se admite en aplicaciones que usan WinRT como marco de aplicación predeterminado.
GetScheduledToastNotifications()	Obtiene la colección de objetos ScheduledToastNotification que esta aplicación ha programado para su presentación. Importante Este método solo se admite en aplicaciones que usan WinRT como marco de aplicación predeterminado.
Hide(ToastNotification)	Quita la notificación del sistema especificada de la pantalla.
RemoveFromSchedule(ScheduledToastNotification)	Cancela la presentación programada de una scheduledToastNotification especificada. Importante Este método solo se admite en aplicaciones que usan WinRT como marco de aplicación predeterminado.
Show(ToastNotification)	Muestra la notificación del sistema especificada.
Update(NotificationData, String)	Novedades la notificación del sistema existente que tiene la etiqueta especificada.
Update(NotificationData, String, String)	Novedades la notificación del sistema existente que tiene la etiqueta especificada y pertenece al grupo de notificaciones especificado.

Eventos

ScheduledToastNotificationShowing

Se produce cuando el sistema muestra la notificación del sistema programada.

Consulte también

• Contenido de notificaciones del sistema
• Esquema de contenido de notificaciones del sistema
• Enviar una notificación del sistema local
• Ejemplos de GitHub de notificaciones de Windows