ToastNotification Class

  • Reference

Definition

Namespace:
Windows.UI.Notifications
Edit

Defines the content, associated metadata and events, and expiration time of a toast notification.

public ref class ToastNotification sealed
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IToastNotificationFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class ToastNotification final
/// [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")]
class ToastNotification final
/// [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.Activatable(typeof(Windows.UI.Notifications.IToastNotificationFactory), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class ToastNotification
[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")]
public sealed class ToastNotification
[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
Inheritance
Object Platform::Object IInspectable ToastNotification
Attributes
ActivatableAttribute ContractVersionAttribute ThreadingAttribute MarshalingBehaviorAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

For how-to guidance for implementing toast notifications in your app, see Send a local toast notification from C# apps.

Guidance for handling app activation for toast notifications:

  • UWP Applications should use the OnActivated for handling toast activations.
  • Starting with WinRT Build 19041, packaged apps (including packaged apps with external location) are able to use ToastNotificationActionTrigger for handling activations for more details.
  • Desktop apps can use COM activation by following Desktop - Send Local Toast.
  • If none of the activation options fit your application, follow the example in this document for properly using event handlers.

Version history

Windows version SDK version Value added
1607 14393 NotificationMirroring
1607 14393 RemoteId
1703 15063 Data
1703 15063 Priority
1903 18362 ExpiresOnReboot

Constructors

ToastNotification(XmlDocument)

Creates and initializes a new instance of the ToastNotification.

Properties

Content

Gets the XML that defines the current toast notification.
Data

Gets or sets additional information about the status of the toast notification.
ExpirationTime

Gets or sets the time after which a toast notification should not be displayed.
ExpiresOnReboot

Indicates whether the toast notification will remain in the Notification Center after a reboot.
Group

Gets or sets the group identifier for the notification.
NotificationMirroring

Gets or sets a value that specifies whether notification mirroring is allowed.
Priority

Gets or sets the priority of the toast notification.
RemoteId

Gets or sets a remote id for the notification that enables the system to correlate this notification with another one generated on another device.
SuppressPopup

Gets or sets whether a toast's pop-up UI is displayed on the user's screen.
Tag

Gets or sets the unique identifier of this notification within the notification Group.

Events

Activated

Occurs when user activates a toast notification through a click or touch. Apps that are running subscribe to this event.
Dismissed

Occurs when a toast notification leaves the screen, either by expiring or being explicitly dismissed by the user. Apps that are running subscribe to this event.
Failed

Occurs when an error is caused when Windows attempts to raise a toast notification. Apps that are running subscribe to this event.

Applies to

See also