TileUpdateManager Class

Definition

Namespace:

Windows.UI.Notifications

Creates TileUpdater objects used to change and update Start menu tiles. This class also provides access to the XML content of the system-provided tile templates so that you can customize that content for use in updating your tiles.

public ref class TileUpdateManager abstract sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class TileUpdateManager final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public static class TileUpdateManager

Public Class TileUpdateManager

Inheritance

Object Platform::Object IInspectable TileUpdateManager

Attributes

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 GetTemplateContent used to retrieve the XML content of a tile template and CreateTileUpdaterForApplication to send the notification to the app's tile.

function sendTileTextNotification() {
    var Notifications = Windows.UI.Notifications;

    // Get an XML DOM version of a specific template by using getTemplateContent.
    var tileXml = Notifications.TileUpdateManager.getTemplateContent(Notifications.TileTemplateType.tileWide310x150Text03);

    // You will need to look at the template documentation to know how many text fields a particular template has.
    // Get the text attribute for this template and fill it in.
    var tileAttributes = tileXml.getElementsByTagName("text");
    tileAttributes[0].appendChild(tileXml.createTextNode("Hello World!"));

    // Create the notification from the XML.
    var tileNotification = new Notifications.TileNotification(tileXml);

    // Send the notification to the calling app's tile.
    Notifications.TileUpdateManager.createTileUpdaterForApplication().update(tileNotification);
}

Remarks

This is a static factory class and requires no instantiation.

Version history

Windows version	SDK version	Value added
1607	14393	GetForUser

Methods

CreateTileUpdaterForApplication()	Creates and initializes a new instance of the TileUpdater, which lets you change the appearance of the calling app's tile.
CreateTileUpdaterForApplication(String)	Creates and initializes a new instance of the TileUpdater for a tile that belongs to another app in the same package as the calling app. The TileUpdater lets a developer change the appearance of that tile.
CreateTileUpdaterForSecondaryTile(String)	Creates and initializes a new instance of the TileUpdater, which enables you to change the appearance of a secondary tile. The tile can belong to the calling app or any other app in the same package.
GetForUser(User)	Creates and initializes a new TileUpdateManagerForUser for the specified user, which lets you change the appearance or content of a tile for a specific user.
GetTemplateContent(TileTemplateType)	Gets the XML content of one of the predefined tile templates so that you can customize it for a tile update. Note When this method is called on a Windows 8 system, it returns a version 1 template. When this method is called on a Windows 8.1 system, it returns a version 2 template. However, if an app specifies Windows 8 compatibility in its manifest, this method returns a version 1 template.

See also

• 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