ScheduledToastNotification 类

定义

命名空间:

Windows.UI.Notifications

包含定义将在计划时间显示的 Toast 通知的 XML。

public ref class ScheduledToastNotification 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.IScheduledToastNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ScheduledToastNotification 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.IScheduledToastNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ScheduledToastNotification

function ScheduledToastNotification(content, deliveryTime, snoozeInterval, maximumSnoozeCount)

Public NotInheritable Class ScheduledToastNotification

继承

Object Platform::Object IInspectable ScheduledToastNotification

属性

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 通知。

var Notifications = Windows.UI.Notifications;
var currentTime = new Date();
var seconds = 60;
var dueTime = new Date(currentTime.getTime() + seconds * 60 * 1000);
var idNumber = Math.floor(Math.random() * 100000000);  // Generates a unique ID number for the notification.

// Set up the notification text.
var toastXml = Notifications.ToastNotificationManager.getTemplateContent(Notifications.ToastTemplateType.toastText02);
var strings = toastXml.getElementsByTagName("text");
strings[0].appendChild(toastXml.createTextNode(This is a scheduled toast notification));
strings[1].appendChild(toastXml.createTextNode("Received: " + dueTime.toLocaleTimeString()));

// Create the toast notification object.
var toast = new Notifications.ScheduledToastNotification(toastXml, dueTime);
toast.id = "Toast" + idNumber;

// Add to the schedule.
Notifications.ToastNotificationManager.createToastNotifier().addToSchedule(toast);

注解

通过调用 ScheduledToastNotification 创建并初始化此对象的新实例。

版本历史记录

Windows 版本	SDK 版本	增值
1607	14393	NotificationMirroring
1607	14393	RemoteId
1803	17134	ExpirationTime

构造函数

ScheduledToastNotification(XmlDocument, DateTime)	创建并初始化将仅显示一次的 ScheduledToastNotification 的新实例。
ScheduledToastNotification(XmlDocument, DateTime, TimeSpan, UInt32)	Windows 10 中已弃用。 在Windows 8系统上，创建并初始化 ScheduledToastNotification 的新实例，该实例在最初出现后的指定时间后重新出现。 在 Windows 10 上，此函数等效于 ScheduledToastNotification (XmlDocument、DateTime) 。 若要在 Windows 10 中实现相同的推迟间隔行为，可以在 Toast 上使用按钮。

属性

Content	获取定义此计划 Toast 通知的 XML。
DeliveryTime	获取计划显示此 Toast 通知的时间。
ExpirationTime	获取或设置通知的过期时间。
Group	获取或设置通知的组标识符。
Id	获取开发人员指定的值，该值用于标识特定的计划 toast。
MaximumSnoozeCount	获取显示此通知的最大次数。
NotificationMirroring	获取或设置一个值，该值指定是否启用通知镜像。 (通知镜像允许通知显示在多个设备上。)
RemoteId	获取或设置通知的远程 ID，使系统能够将此通知与其他设备上生成的通知相关联。
SnoozeInterval	获取通知出现之间的时间。
SuppressPopup	获取或设置 Toast 的弹出 UI 是否显示在用户的屏幕上。
Tag	获取或设置一个字符串，该字符串唯一标识 组内的 Toast 通知。

另请参阅

• 计划通知示例
• Toast 架构
• 计划通知指南和清单