ToastNotificationManager Classe

Définition

Espace de noms:

Windows.UI.Notifications

Crée des objets ToastNotifier que vous utilisez pour déclencher des notifications toast. Cette classe permet également d’accéder au contenu XML des modèles toast fournis par le système afin que vous puissiez personnaliser ce contenu pour l’utiliser dans vos notifications.

public ref class ToastNotificationManager abstract sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotificationManager final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public static class ToastNotificationManager

Public Class ToastNotificationManager

Héritage

Object Platform::Object IInspectable ToastNotificationManager

Attributs

ContractVersionAttribute ThreadingAttribute 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 des méthodes GetTemplateContent et CreateToastNotifier .

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(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);

Remarques

Envoi de notifications toast à partir d’applications de bureau

En règle générale, l’envoi d’une notification toast à partir d’une application de bureau est identique à l’envoi à partir d’une application UWP. Toutefois, vous devez être conscient de ces différences et exigences :

• Pour qu’une application de bureau affiche un toast, l’application doit avoir un raccourci sur l’écran d’accueil.
• Le raccourci doit avoir un AppUserModelID.
• Les applications de bureau ne peuvent pas planifier de toast.

Pour plus d’informations, consultez les rubriques suivantes :

• Guide pratique pour activer les notifications toast de bureau via un AppUserModelID
• Démarrage rapide : Envoi d’une notification toast à partir du bureau

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1607	14393	ConfigureNotificationMirroring
1607	14393	GetForUser
1703	15063	GetDefault

Propriétés

History

Obtient l’objet ToastNotificationHistory .

Méthodes

ConfigureNotificationMirroring(NotificationMirroring)	Spécifie si la mise en miroir des notifications est autorisée. La mise en miroir de notifications permet de diffuser une notification sur plusieurs appareils.
CreateToastNotifier()	Crée et initialise une nouvelle instance de ToastNotification, liée à l’application appelante, qui vous permet d’envoyer une notification toast à cette application.
CreateToastNotifier(String)	Crée et initialise une nouvelle instance de ToastNotification, liée à une application spécifiée, généralement une autre application dans le même package.
GetDefault()	Obtient un gestionnaire de notifications toast pour l’utilisateur actuel.
GetForUser(User)	Obtient un gestionnaire de notifications toast pour l’utilisateur spécifié.
GetTemplateContent(ToastTemplateType)	Obtient le contenu XML de l’un des modèles toast prédéfinis afin que vous puissiez le personnaliser pour l’utiliser dans votre notification.

Voir aussi

• Exemple de notifications de toast
• Exemple d’envoi de notifications toast à partir d’applications de bureau
• Schéma XML toast
• Vue d’ensemble des notifications Toast
• Démarrage rapide : Envoi d’une notification toast
• Démarrage rapide : Envoi d’une notification Push toast
• Démarrage rapide : Envoi d’une notification toast à partir du bureau
• Recommandations et liste de contrôle pour les notifications toast
• Comment gérer l’activation à partir d’une notification toast
• Comment opter pour les notifications toast
• Comment planifier une notification toast
• Guide pratique pour activer les notifications toast de bureau via un AppUserModelID
• Catalogue de modèles toast
• Options audio toast