-api-id | -api-type | -api-device-family-note |
---|---|---|
M:Windows.UI.Notifications.ToastNotificationManager.CreateToastNotifier |
winrt method |
xbox |
Creates and initializes a new instance of the ToastNotification, bound to the calling application, that lets you raise a toast notification to that app.
The object you will use to send the toast notification to the app.
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.
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);
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