ToastNotifier 类

定义

命名空间:

Windows.UI.Notifications

向 ToastNotifier 绑定到的特定应用引发 Toast 通知。 此类还允许计划和删除 Toast 通知。

public ref class ToastNotifier sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotifier final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ToastNotifier

Public NotInheritable Class ToastNotifier

继承

Object Platform::Object IInspectable ToastNotifier

属性

ContractVersionAttribute 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 通知，包括使用 Show 方法。

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

以下示例演示如何使用 GetScheduledToastNotifications 和 RemoveFromSchedule 方法。

var notifier = Notifications.ToastNotificationManager.createToastNotifier();
var scheduled = notifier.getScheduledToastNotifications();                    

for (var i = 0, len = scheduled.length; i < len; i++) {

    // The itemId value is the unique ScheduledTileNotification.Id assigned to the 
    // notification when it was created.
    if (scheduled[i].id === itemId) {
        notifier.removeFromSchedule(scheduled[i]);
    }
}

注解

创建时，ToastNotifier 绑定到特定应用，因此此类的方法仅影响该应用。

版本历史记录

Windows 版本	SDK 版本	已添加值
1703	15063	更新 (NotificationData，String，String)
1703	15063	更新 (NotificationData，字符串)
1809	17763	ScheduledToastNotificationShowing

属性

Setting

获取一个值，该值指示是否存在阻止显示 Toast 通知的应用、用户或系统块。

方法

AddToSchedule(ScheduledToastNotification)	添加 ScheduledToastNotification 以供 Windows 稍后显示。 重要 此方法仅在使用 WinRT 作为其默认应用程序框架的应用程序中受支持。
GetScheduledToastNotifications()	获取此应用已计划显示的 ScheduledToastNotification 对象的集合。 重要 此方法仅在使用 WinRT 作为其默认应用程序框架的应用程序中受支持。
Hide(ToastNotification)	从屏幕中删除指定的 Toast 通知。
RemoveFromSchedule(ScheduledToastNotification)	取消指定 ScheduledToastNotification 的计划显示。 重要 此方法仅在使用 WinRT 作为其默认应用程序框架的应用程序中受支持。
Show(ToastNotification)	显示指定的 Toast 通知。
Update(NotificationData, String)	汇报具有指定标记的现有 Toast 通知。
Update(NotificationData, String, String)	汇报具有指定标记并属于指定通知组的现有 Toast 通知。

事件

ScheduledToastNotificationShowing

当系统显示计划的 Toast 通知时发生。

另请参阅

• Toast 内容
• Toast 内容架构
• 发送本地 toast 通知
• Windows 通知 GitHub 示例