Share via

ScheduledTileNotification Class

Definition

Namespace:
Windows.UI.Notifications
Edit

Defines the visual content and timing for a single, non-recurring scheduled update to a tile.

public ref class ScheduledTileNotification sealed
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IScheduledTileNotificationFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class ScheduledTileNotification final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IScheduledTileNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class ScheduledTileNotification final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IScheduledTileNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ScheduledTileNotification final
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IScheduledTileNotificationFactory), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class ScheduledTileNotification
[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.IScheduledTileNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class ScheduledTileNotification
[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.IScheduledTileNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ScheduledTileNotification
function ScheduledTileNotification(content, deliveryTime)
Public NotInheritable Class ScheduledTileNotification
Inheritance
Object Platform::Object IInspectable ScheduledTileNotification
Attributes
ActivatableAttribute ContractVersionAttribute ThreadingAttribute MarshalingBehaviorAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

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

var currentTime = DateTime.Now;
var seconds = 60;
var dueTime = currentTime.AddSeconds(seconds * 60);
var idNumber = new Random().Next(0, 100000000);

var tileXml = TileUpdateManager.GetTemplateContent(TileTemplateType.TileWide310x150Text09);

// Set up the wide tile text.
var tileTextAttributes = tileXml.GetElementsByTagName("text");
tileTextAttributes[0].AppendChild(tileXml.CreateTextNode("This is a scheduled notification"));
tileTextAttributes[1].AppendChild(tileXml.CreateTextNode("Received: " + dueTime.ToLocalTime().ToString()));

// Set up the medium tile text.
var squareTileXml = TileUpdateManager.GetTemplateContent(TileTemplateType.TileSquare150x150Text04);
var squareTileTextAttributes = squareTileXml.GetElementsByTagName("text");
squareTileTextAttributes[0].AppendChild(squareTileXml.CreateTextNode("This is a scheduled notification"));

// Include the medium tile in the notification.
var node = tileXml.ImportNode(squareTileXml.GetElementsByTagName("binding").Item(0), true);
tileXml.GetElementsByTagName("visual").Item(0).AppendChild(node);

// Create the notification object.
var futureTile = new ScheduledTileNotification(tileXml, dueTime);
futureTile.Id = "Tile" + idNumber;

// Add to the schedule.
TileUpdateManager.CreateTileUpdaterForApplication().AddToSchedule(futureTile);

Constructors

ScheduledTileNotification(XmlDocument, DateTime)

Creates and initializes a new instance of the ScheduledTileNotification object for use with a TileUpdater.

Properties

Content

Gets the XML description of the content of the scheduled tile update.
DeliveryTime

Gets the time at which the tile is scheduled to be updated.
ExpirationTime

Gets or sets the time after which the tile notification should no longer be shown. By default, a tile notification does not expire. It is a best practice to explicitly set an expiration time to avoid stale content.
Id

Gets or sets the unique ID that is used to identify the scheduled tile in the schedule.
Tag

Gets or sets a string that Windows can use to prevent duplicate notification content from appearing in the queue.

Applies to