This topic has not yet been rated - Rate this topic

BadgeUpdater class

Updates a badge overlay on the specific tile that the updater is bound to.

Syntax


var badgeUpdater = createBadgeUpdaterForApplication();
var badgeUpdater = createBadgeUpdaterForApplication(applicationId);
var badgeUpdater = createBadgeUpdaterForSecondaryTile(tileId);

Attributes

MuseAttribute()
VersionAttribute(NTDDI_WIN8)

Members

The BadgeUpdater class has these types of members:

Methods

Methods

The BadgeUpdater class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

Method	Description
Clear	Removes the badge from the tile that the updater is bound to.
StartPeriodicUpdate(Uri, DateTime, PeriodicUpdateRecurrence)	Begins a series of timed updates for the badge from a web resource that the updater is bound to. Updates begin at a specified time.
StartPeriodicUpdate(Uri, PeriodicUpdateRecurrence)	Begins a series of timed updates for the badge from a web resource that the updater is bound to, beginning immediately.
StopPeriodicUpdate	Cancels the current series of timed updates for the badge that the updater is bound to.
Update	Applies a change to the badge's glyph or number.

Remarks

To get an instance of this object, call the BadgeUpdateManager.CreateBadgeUpdaterForApplication or BadgeUpdateManager.CreateBadgeUpdaterForSecondaryTile method.

When it is created, BadgeUpdater is bound to a specific app or secondary tile, so the methods of this class affect only the single tile that the object instance is bound to.

Examples

The following example shows the use of Update to send a numeric badge update to the calling app's tile.

JavaScript



function sendBadgeNotification() {
    var Notifications = Windows.UI.Notifications;
    var badgeXml;
    var badgeAttributes;

    // Get an XML DOM version of a specific template by using getTemplateContent.
    badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber);
    badgeAttributes = badgeXml.getElementsByTagName("badge");
    badgeAttributes[0].setAttribute("value", "7");

    // Create a badge notification from the XML content.
    var badgeNotification = new Notifications.BadgeNotification(badgeXml);

    // Send the badge notification to the app's tile.
    Notifications.BadgeUpdateManager.createBadgeUpdaterForApplication().update(badgeNotification);
}

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.Notifications Windows::UI::Notifications [C++]
Metadata	Windows.winmd