ToastNotification 类

定义

命名空间:

Windows.UI.Notifications

定义 Toast 通知的内容、关联的元数据和事件以及过期时间。

public ref class ToastNotification sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IToastNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotification final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IToastNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ToastNotification

function ToastNotification(content)

Public NotInheritable Class ToastNotification

继承

Object Platform::Object IInspectable ToastNotification

属性

ActivatableAttribute 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 通知的操作指南，请参阅 从 C# 应用发送本地 Toast 通知。

处理 Toast 通知的应用激活指南：

• UWP 应用程序应使用 OnActivated 来处理 Toast 激活。
• 从 WinRT 内部版本 19041 开始，打包的应用 (包括具有外部位置的打包应用) 能够使用 ToastNotificationActionTrigger 来处理激活 ，了解更多详细信息。
• 桌面应用可以通过遵循 桌面 - 发送本地 Toast 来使用 COM 激活。
• 如果没有任何激活选项适合应用程序，请按照本文档中的示例正确使用事件处理程序。

版本历史记录

Windows 版本	SDK 版本	增值
1607	14393	NotificationMirroring
1607	14393	RemoteId
1703	15063	数据
1703	15063	优先级
1903	18362	ExpiresOnReboot

构造函数

ToastNotification(XmlDocument)

创建并初始化 ToastNotification 的新实例。

属性

Content	获取定义当前 Toast 通知的 XML。
Data	获取或设置有关 Toast 通知状态的其他信息。
ExpirationTime	获取或设置不应显示 Toast 通知的时间。
ExpiresOnReboot	指示重新启动后 Toast 通知是否保留在通知中心。
Group	获取或设置通知的组标识符。
NotificationMirroring	获取或设置一个值，该值指定是否允许通知镜像。
Priority	获取或设置 Toast 通知的优先级。
RemoteId	获取或设置通知的远程 ID，使系统能够将此通知与其他设备上生成的通知相关联。
SuppressPopup	获取或设置 Toast 的弹出 UI 是否显示在用户的屏幕上。
Tag	获取或设置通知 组中此通知的唯一标识符。

事件

Activated	当用户通过单击或触摸激活 Toast 通知时发生。 正在运行的应用订阅此事件。
Dismissed	当 Toast 通知离开屏幕时发生，该通知即将过期或被用户显式消除。 正在运行的应用订阅此事件。
Failed	当 Windows 尝试引发 Toast 通知时导致错误时发生。 正在运行的应用订阅此事件。

另请参阅

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