Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BadgeUpdater class

Applies to Windows and Windows Phone

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

Syntax


public ref class BadgeUpdater sealed 

Attributes

[Muse()]
[Version(0x06020000)]

Members

The BadgeUpdater class has these types of members:

Methods

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

MethodDescription
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.



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]

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

App tiles and badges sample
Guidelines and checklist for tiles and badges
How to clear a badge
How to send a glyph or numeric badge in a local notification
How to set up periodic notifications for badges
How to update a badge through push notifications
Badge XML schema
Badge overview

 

 

Show:
© 2014 Microsoft. All rights reserved.