TileNotification.ExpirationTime | expirationTime property

Applies to Windows and Windows Phone

Gets or sets the time that Windows will remove the notification from the tile. By default, a tile update does not expire. It is a best practice to explicitly set an expiration time to avoid stale content.

Syntax


public Nullable<DateTimeOffset> ExpirationTime { get; set; }

Property value

Type: IReference<DateTime> [JavaScript/C++] | System.Nullable<DateTime> [.NET]

The date and time that the notification should be removed.

Examples

The following example uses ExpirationTime to show a tile notification for 30 seconds.



function tileNotificationExpiration() {
    var Notifications = Windows.UI.Notifications;
    var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text04);

    var currentTime = new Date();
    var seconds = 30;

    var tileTextAttributes = tileXml.getElementsByTagName("text");
    tileTextAttributes[0].appendChild(tileXml.createTextNode("This notification will expire at " + new Date(currentTime.getTime() + seconds * 1000)));

    var tileNotification = new Notifications.TileNotification(tileXml);

    // Set the expiration time on the notification
    var expiryTime = new Date(currentTime.getTime() + seconds * 1000);

    tileNotification.expirationTime = expiryTime;
    Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification);
}

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

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

TileNotification
How to use the notification queue with local notifications
App tiles and badges sample
Quickstart: Sending a tile update
Tile and tile notification overview
The tile template catalog
Guidelines and checklist for tiles
How to schedule a tile notification
How to set up periodic notifications for tiles
Tiles XML schema

 

 

Show:
© 2014 Microsoft