| description | Learn how to use badge notification to conveys summary or status information specific to your app. |
|---|---|
| title | Badge notifications for Windows apps |
| ms.assetid | 48ee4328-7999-40c2-9354-7ea7d488c538 |
| label | Tiles, badges, and notifications |
| template | detail.hbs |
| ms.date | 02/27/2025 |
| ms.topic | how-to |
| keywords | windows 10, uwp |
| ms.localizationpriority | medium |
A notification badge conveys summary or status information specific to your app. They can be numeric (1-99) or one of a set of system-provided glyphs. Examples of information best conveyed through a badge include network connection status in an online game, user status in a messaging app, number of unread mails in a mail app, and number of new posts in a social media app.
Notification badges appear on your app's taskbar icon and in the lower-right corner of its start tile, regardless of whether the app is running. Badges can be displayed on all tile sizes.
Note
You cannot provide your own badge image; only system-provided badge images can be used.
| Value | Badge | XML |
|---|---|---|
| A number from 1 to 99. A value of 0 is equivalent to the glyph value "none" and will clear the badge. |  |
<badge value="1"/> |
| Any number greater than 99. |  |
<badge value="100"/> |
Instead of a number, a badge can display one of a non-extensible set of status glyphs.
| Status | Glyph | XML |
|---|---|---|
| none | (No badge shown.) | <badge value="none"/> |
| activity | :::image source="images/badges/badge-activity.png" alt-text="A glyph badge denoting the 'activity' status."::: | <badge value="activity"/> |
| alarm | :::image source="images/badges/badge-alarm.png" alt-text="A glyph badge denoting the 'alarm' status."::: | <badge value="alarm"/> |
| alert | :::image source="images/badges/badge-alert.png" alt-text="A glyph badge denoting the 'alert' status."::: | <badge value="alert"/> |
| attention | :::image source="images/badges/badge-attention.png" alt-text="A glyph badge denoting the 'attention' status."::: | <badge value="attention"/> |
| available | :::image source="images/badges/badge-available.png" alt-text="A glyph badge denoting the 'available' status."::: | <badge value="available"/> |
| away | :::image source="images/badges/badge-away.png" alt-text="A glyph badge denoting the 'away' status."::: | <badge value="away"/> |
| busy | :::image source="images/badges/badge-busy.png" alt-text="A glyph badge denoting the 'busy' status."::: | <badge value="busy"/> |
| error | :::image source="images/badges/badge-error.png" alt-text="A glyph badge denoting the 'error' status."::: | <badge value="error"/> |
| newMessage | :::image source="images/badges/badge-newMessage.png" alt-text="A glyph badge denoting the 'newMessage' status."::: | <badge value="newMessage"/> |
| paused | :::image source="images/badges/badge-paused.png" alt-text="A glyph badge denoting the 'paused' status."::: | <badge value="paused"/> |
| playing | :::image source="images/badges/badge-playing.png" alt-text="A glyph badge denoting the 'playing' status."::: | <badge value="playing"/> |
| unavailable | :::image source="images/badges/badge-unavailable.png" alt-text="A glyph badge denoting the 'unavailable' status."::: | <badge value="unavailable"/> |
These examples show you how to create a badge update.
private void setBadgeNumber(int num)
{
// Get the blank badge XML payload for a badge number
XmlDocument badgeXml =
BadgeUpdateManager.GetTemplateContent(BadgeTemplateType.BadgeNumber);
// Set the value of the badge in the XML to our number
XmlElement badgeElement = badgeXml.SelectSingleNode("/badge") as XmlElement;
badgeElement.SetAttribute("value", num.ToString());
// Create the badge notification
BadgeNotification badge = new BadgeNotification(badgeXml);
// Create the badge updater for the application
BadgeUpdater badgeUpdater =
BadgeUpdateManager.CreateBadgeUpdaterForApplication();
// And update the badge
badgeUpdater.Update(badge);
}private void updateBadgeGlyph()
{
string badgeGlyphValue = "alert";
// Get the blank badge XML payload for a badge glyph
XmlDocument badgeXml =
BadgeUpdateManager.GetTemplateContent(BadgeTemplateType.BadgeGlyph);
// Set the value of the badge in the XML to our glyph value
Windows.Data.Xml.Dom.XmlElement badgeElement =
badgeXml.SelectSingleNode("/badge") as Windows.Data.Xml.Dom.XmlElement;
badgeElement.SetAttribute("value", badgeGlyphValue);
// Create the badge notification
BadgeNotification badge = new BadgeNotification(badgeXml);
// Create the badge updater for the application
BadgeUpdater badgeUpdater =
BadgeUpdateManager.CreateBadgeUpdaterForApplication();
// And update the badge
badgeUpdater.Update(badge);
}private void clearBadge()
{
BadgeUpdateManager.CreateBadgeUpdaterForApplication().Clear();
}- Windows App SDK notifications sample
Shows how to send app notifications and badge updates.