ToastNotification Classe

Définition

Espace de noms:

Windows.UI.Notifications

Définit le contenu, les métadonnées et les événements associés, ainsi que le délai d’expiration d’une notification toast.

public ref class ToastNotification sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IToastNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotification final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IToastNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ToastNotification

function ToastNotification(content)

Public NotInheritable Class ToastNotification

Héritage

Object Platform::Object IInspectable ToastNotification

Attributs

ActivatableAttribute 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)

Remarques

Pour obtenir des conseils pratiques pour implémenter des notifications toast dans votre application, consultez Envoyer une notification toast locale à partir d’applications C#.

Conseils pour la gestion de l’activation des applications pour les notifications toast :

• Les applications UWP doivent utiliser OnActivated pour gérer les activations toast.
• À compter de WinRT Build 19041, les applications empaquetées (y compris les applications empaquetées avec un emplacement externe) peuvent utiliser ToastNotificationActionTrigger pour gérer les activations pour plus de détails.
• Les applications de bureau peuvent utiliser l’activation COM en suivant Desktop - Send Local Toast.
• Si aucune des options d’activation ne convient à votre application, suivez l’exemple de ce document pour utiliser correctement les gestionnaires d’événements.

Historique des versions

Version de Windows	Version du SDK	Valeur ajoutée
1607	14393	NotificationMirroring
1607	14393	RemoteId
1703	15063	Données
1703	15063	Priorité
1903	18362	ExpiresOnReboot

Constructeurs

ToastNotification(XmlDocument)

Crée et initialise une nouvelle instance de ToastNotification.

Propriétés

Content	Obtient le code XML qui définit la notification toast actuelle.
Data	Obtient ou définit des informations supplémentaires sur la status de la notification toast.
ExpirationTime	Obtient ou définit l’heure après laquelle une notification toast ne doit pas être affichée.
ExpiresOnReboot	Indique si la notification toast restera dans le Centre de notifications après un redémarrage.
Group	Obtient ou définit l’identificateur de groupe pour la notification.
NotificationMirroring	Obtient ou définit une valeur qui spécifie si la mise en miroir des notifications est autorisée.
Priority	Obtient ou définit la priorité de la notification toast.
RemoteId	Obtient ou définit un ID distant pour la notification qui permet au système de mettre en corrélation cette notification avec une autre notification générée sur un autre appareil.
SuppressPopup	Obtient ou définit si l’interface utilisateur contextuelle d’un toast s’affiche sur l’écran de l’utilisateur.
Tag	Obtient ou définit l’identificateur unique de cette notification dans le groupe de notifications.

Événements

Activated	Se produit lorsque l’utilisateur active une notification toast par un clic ou une touche tactile. Les applications en cours d’exécution s’abonnent à cet événement.
Dismissed	Se produit lorsqu’une notification toast quitte l’écran, en arrivant à expiration ou en étant explicitement ignorée par l’utilisateur. Les applications en cours d’exécution s’abonnent à cet événement.
Failed	Se produit lorsqu’une erreur est provoquée lorsque Windows tente de déclencher une notification toast. Les applications en cours d’exécution s’abonnent à cet événement.

Voir aussi

• Exemple de notifications de toast
• Exemple d’envoi de notifications toast à partir d’applications de bureau
• Schéma XML toast
• Vignettes, badges et notifications
• 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