ToastNotificationManager Class

Definition

Namespace:

Windows.UI.Notifications

Creates ToastNotifier objects that you use to raise toast notifications. This class also provides access to the XML content of the system-provided toast templates so that you can customize that content for use in your 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

Inheritance

Object Platform::Object IInspectable ToastNotificationManager

Attributes

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)

Examples

The following example shows how to create and send a toast notification that includes text and images, including the use of the GetTemplateContent and CreateToastNotifier methods.

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

Remarks

Sending toast notifications from desktop apps

Generally, sending a toast notification from a desktop app is the same as sending it from a UWP app. However, you should be aware of these differences and requirements:

• For a desktop app to display a toast, the app must have a shortcut on the Start screen.
• The shortcut must have an AppUserModelID.
• Desktop apps cannot schedule a toast.

For more information, see these topics:

• How to enable desktop toast notifications through an AppUserModelID
• Quickstart: Sending a toast notification from the desktop

Version history

Windows version	SDK version	Value added
1607	14393	ConfigureNotificationMirroring
1607	14393	GetForUser
1703	15063	GetDefault

Properties

History

Gets the ToastNotificationHistory object.

Methods

ConfigureNotificationMirroring(NotificationMirroring)	Specifies whether notification mirroring is allowed. Notification mirroring enables a notification to be broadcast on multiple devices.
CreateToastNotifier()	Creates and initializes a new instance of the ToastNotification, bound to the calling application, that lets you raise a toast notification to that app.
CreateToastNotifier(String)	Creates and initializes a new instance of the ToastNotification, bound to a specified app, usually another app in the same package.
GetDefault()	Gets a toast notification manager for the current user.
GetForUser(User)	Gets a toast notification manager for the specified user.
GetTemplateContent(ToastTemplateType)	Gets the XML content of one of the predefined toast templates so that you can customize it for use in your notification.

See also

• Toast notifications sample
• Sending toast notifications from desktop apps sample
• Toast XML schema
• Toast notification overview
• Quickstart: Sending a toast notification
• Quickstart: Sending a toast push notification
• Quickstart: Sending a toast notification from the desktop
• Guidelines and checklist for toast notifications
• How to handle activation from a toast notification
• How to opt in for toast notifications
• How to schedule a toast notification
• How to enable desktop toast notifications through an AppUserModelID
• The toast template catalog
• Toast audio options