ToastNotificationManager 类

定义

命名空间:

Windows.UI.Notifications

创建用于引发 Toast 通知的 ToastNotifier 对象。 此类还提供对系统提供的 Toast 模板的 XML 内容的访问权限，以便您可以自定义该内容以用于通知。

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

继承

Object Platform::Object IInspectable ToastNotificationManager

属性

ContractVersionAttribute ThreadingAttribute MarshalingBehaviorAttribute

Windows 要求

设备系列	Windows 10 (在 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

以下示例演示如何创建和发送包含文本和图像的 Toast 通知，包括使用 GetTemplateContent 和 CreateToastNotifier 方法。

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

注解

从桌面应用发送 Toast 通知

通常，从桌面应用发送 Toast 通知与从 UWP 应用发送 Toast 通知相同。 但是，应注意以下差异和要求：

• 要使桌面应用显示 Toast，应用必须在“开始”屏幕上具有快捷方式。
• 快捷方式必须具有 AppUserModelID。
• 桌面应用无法计划 Toast。

有关详细信息，请参阅以下主题：

• 如何通过 AppUserModelID 启用桌面 toast 通知
• 快速入门：从桌面发送 Toast 通知

版本历史记录

Windows 版本	SDK 版本	增值
1607	14393	ConfigureNotificationMirroring
1607	14393	GetForUser
1703	15063	GetDefault

属性

History

获取 ToastNotificationHistory 对象。

方法

ConfigureNotificationMirroring(NotificationMirroring)	指定是否允许通知镜像。 通知镜像允许在多个设备上广播通知。
CreateToastNotifier()	创建并初始化绑定到调用应用程序的 ToastNotification 的新实例，该实例可让你向该应用发出 Toast 通知。
CreateToastNotifier(String)	创建并初始化 ToastNotification 的新实例，该实例绑定到指定的应用，通常是同一包中的另一个应用。
GetDefault()	获取当前用户的 Toast 通知管理器。
GetForUser(User)	获取指定用户的 Toast 通知管理器。
GetTemplateContent(ToastTemplateType)	获取其中一个预定义 Toast 模板的 XML 内容，以便可以对其进行自定义，以便在通知中使用。

另请参阅

• Toast 通知示例
• 从桌面应用发送 toast 通知示例
• Toast XML 架构
• Toast 通知概述
• 快速入门：发送 Toast 通知
• 快速入门：发送 Toast 推送通知
• 快速入门：从桌面发送 Toast 通知
• Toast 通知指南和清单
• 如何处理 Toast 通知中的激活
• 如何选择加入 Toast 通知
• 如何计划 Toast 通知
• 如何通过 AppUserModelID 启用桌面 toast 通知
• Toast 模板目录
• Toast 音频选项