ScheduledToastNotification class

Applies to Windows and Windows Phone

Contains the XML that defines the toast notification that will display at the scheduled time.

Syntax


var scheduledToastNotification = new Windows.UI.Notifications.ScheduledToastNotification(xmlDocument, dateTime);
var scheduledToastNotification = new Windows.UI.Notifications.ScheduledToastNotification(xmlDocument, dateTime, timeSpan, uInt32);

Attributes

[Threading(MTA)]
[Version(0x06020000)]

Members

The ScheduledToastNotification class has these types of members:

Constructors

The ScheduledToastNotification class has these constructors.

ConstructorDescription
ScheduledToastNotification(XmlDocument,DateTime) Creates and initializes a new instance of a ScheduledToastNotification that will be displayed only once.
ScheduledToastNotification(XmlDocument,DateTime,TimeSpan,UInt32) Creates and initializes a new instance of a recurring ScheduledToastNotification.

 

Properties

The ScheduledToastNotification class has these properties.

PropertyAccess typeDescription

Content

Read-onlyGets the XML that defines this scheduled toast notification.

DeliveryTime

Read-onlyGets the time that this toast notification is scheduled to be displayed.

Group

Read/writeGets or sets the group identifier for the notification.

Id

Read/writeGets a developer-specified value used to identify a specific scheduled toast.

MaximumSnoozeCount

Read-onlyGets the maximum number of times to display this notification.

SnoozeInterval

Read-onlyGets the amount of time between occurrences of the notification.

SuppressPopup

Read/writeGets or sets whether a toast's pop-up UI is displayed on the Windows Phone 8.1 screen.

Tag

Read/writeGets or sets a string that uniquely identifies a toast notification inside a Group.

 

Remarks

Create and initialize a new instance of this object by calling ScheduledToastNotification.

Examples

The following example shows a toast notification scheduled to display in one hour.



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

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.UI.Notifications
Windows::UI::Notifications [C++]

Metadata

Windows.winmd

See also

Scheduled notifications sample
Toast schema
Guidelines and checklist for scheduled notifications

 

 

Show:
© 2014 Microsoft