ToastNotificationManager ToastNotificationManager ToastNotificationManager ToastNotificationManager Class

Gets the ToastNotificationHistory object.

public : static ToastNotificationHistory History { get; }public static ToastNotificationHistory History { get; }Public Static ReadOnly Property History As ToastNotificationHistory// You can use this property in JavaScript.

Specifies whether notification mirroring is allowed. Notification mirroring enables a notification to be broadcast on multiple devices.

public : static void ConfigureNotificationMirroring(NotificationMirroring value)public static void ConfigureNotificationMirroring(NotificationMirroring value)Public Static Function ConfigureNotificationMirroring(value As NotificationMirroring) As void// You can use this method in JavaScript.

Creates and initializes a new instance of the ToastNotification, bound to the calling application, that lets you raise a toast notification to that app.

public : static ToastNotifier CreateToastNotifier()public static ToastNotifier CreateToastNotifier()Public Static Function CreateToastNotifier() As ToastNotifier// You can use this method in JavaScript.

Examples

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

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

Do not use this overload when creating a toast notifier for a desktop app. Use CreateToastNotifier(appID) to supply the required AppUserModelID.

If your app uses a background voice-over-Internet protocol (VOIP) agent, it must specify the app ID to show a toast. Use the CreateToastNotifier(appID) method overload.

See Also

CreateToastNotifier(String)CreateToastNotifier(String)CreateToastNotifier(String)CreateToastNotifier(String)

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

Creates and initializes a new instance of the ToastNotification, bound to a specified app, usually another app in the same package.

public : static ToastNotifier CreateToastNotifier(PlatForm::String applicationId)public static ToastNotifier CreateToastNotifier(String applicationId)Public Static Function CreateToastNotifier(applicationId As String) As ToastNotifier// You can use this method in JavaScript.

Remarks

The app identified by applicationId must belong to the same package as the caller.

Use this form of the method if your app uses a background voice-over-Internet protocol (VOIP) agent, to specify the app ID required to show a toast in that case.

Sending toast notifications from desktop apps

Generally, sending a toast notification from a desktop app is the same as sending it from a Windows Store 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

See Also

CreateToastNotifier()CreateToastNotifier()CreateToastNotifier()CreateToastNotifier()

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

Gets a toast notification manager for the current user.

public : static ToastNotificationManagerForUser GetDefault()public static ToastNotificationManagerForUser GetDefault()Public Static Function GetDefault() As ToastNotificationManagerForUser// You can use this method in JavaScript.

Gets a toast notification manager for the specified user.

public : static ToastNotificationManagerForUser GetForUser(User user)public static ToastNotificationManagerForUser GetForUser(User user)Public Static Function GetForUser(user As User) As ToastNotificationManagerForUser// You can use this method in JavaScript.

Gets the XML content of one of the predefined toast templates so that you can customize it for use in your notification.

public : static XmlDocument GetTemplateContent(ToastTemplateType type)public static XmlDocument GetTemplateContent(ToastTemplateType type)Public Static Function GetTemplateContent(type As ToastTemplateType) As XmlDocument// You can use this method in JavaScript.

Examples

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

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

Instead of creating the full XML payload yourself, you can get a template and then use Document Object Model (DOM) manipulation functions to customize the part of the content that you want to change. You package this XML in a ToastNotification and send it to the tile through the ToastNotifier that you create through the other methods of this class.

See tile schema for an explanation of tile elements and attributes.

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