ToastNotifier Classe

Définition

Espace de noms:

Windows.UI.Notifications

Déclenche une notification toast à l’application spécifique à laquelle toastNotifier est lié. Cette classe vous permet également de planifier et de supprimer des notifications toast.

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

Héritage

Object Platform::Object IInspectable ToastNotifier

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

L’exemple suivant montre comment créer et envoyer une notification toast qui inclut du texte et des images, y compris l’utilisation de la méthode 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);

L’exemple suivant montre l’utilisation des méthodes GetScheduledToastNotifications et 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]);
    }
}

Remarques

Lorsqu’il est créé, ToastNotifier étant lié à une application spécifique, les méthodes de cette classe affectent uniquement cette application.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1703	15063	Update(NotificationData,String,String)
1703	15063	Update(NotificationData,String)
1809	17763	ScheduledToastNotificationShowing

Propriétés

Setting

Obtient une valeur qui vous indique s’il existe une application, un utilisateur ou un bloc système qui empêche l’affichage d’une notification toast.

Méthodes

AddToSchedule(ScheduledToastNotification)	Ajoute un ScheduledToastNotification pour un affichage ultérieur par Windows. Important Cette méthode est uniquement prise en charge dans les applications qui utilisent WinRT comme infrastructure d’application par défaut.
GetScheduledToastNotifications()	Obtient la collection d’objets ScheduledToastNotification que cette application a planifié pour l’affichage. Important Cette méthode est uniquement prise en charge dans les applications qui utilisent WinRT comme infrastructure d’application par défaut.
Hide(ToastNotification)	Supprime la notification toast spécifiée de l’écran.
RemoveFromSchedule(ScheduledToastNotification)	Annule l’affichage planifié d’un ScheduledToastNotification spécifié. Important Cette méthode est uniquement prise en charge dans les applications qui utilisent WinRT comme infrastructure d’application par défaut.
Show(ToastNotification)	Affiche la notification toast spécifiée.
Update(NotificationData, String)	Mises à jour la notification toast existante qui a la balise spécifiée.
Update(NotificationData, String, String)	Mises à jour la notification toast existante qui a la balise spécifiée et appartient au groupe de notifications spécifié.

Événements

ScheduledToastNotificationShowing

Se produit lorsque le système affiche la notification toast planifiée.

Voir aussi

• Contenu des toasts
• Schéma du contenu de notification toast
• Envoyer une notification toast locale
• Exemples GitHub des notifications Windows