Windows.​UI.​Notifications Windows.​UI.​Notifications Windows.​UI.​Notifications Namespace

Contains classes that encapsulate tile, toast, and badge notifications.

Classes

AdaptiveNotificationText AdaptiveNotificationText AdaptiveNotificationText

Represents the text content of an adaptive notification.

BadgeNotification BadgeNotification BadgeNotification

Defines the content, associated metadata, and expiration time of an update to a tile's badge overlay. A badge can display a number from 1 to 99 or a status glyph.

BadgeUpdateManager BadgeUpdateManager BadgeUpdateManager

Creates BadgeUpdater objects that you use to manipulate a tile's badge overlay. This class also provides access to the XML content of the system-provided badge templates so that you can customize that content for use in updating your badges.

BadgeUpdateManagerForUser BadgeUpdateManagerForUser BadgeUpdateManagerForUser

Creates BadgeUpdater objects that you use to manipulate a tile's badge overlay for a specific user. This class also provides access to the XML content of the system-provided badge templates so that you can customize that content for use in updating your badges.

BadgeUpdater BadgeUpdater BadgeUpdater

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

KnownAdaptiveNotificationHints KnownAdaptiveNotificationHints KnownAdaptiveNotificationHints

Specifies the types of hints available to adaptive notifications.

KnownAdaptiveNotificationTextStyles KnownAdaptiveNotificationTextStyles KnownAdaptiveNotificationTextStyles

Specifies the text styles available for adaptive notifications.

KnownNotificationBindings KnownNotificationBindings KnownNotificationBindings

Specifies the binding templates available for adaptive notifications.

Notification Notification Notification

Represents a notification.

NotificationBinding NotificationBinding NotificationBinding

Represents the binding element of an adaptive notification.

NotificationData NotificationData NotificationData

Stores data for display in a toast notification.

NotificationVisual NotificationVisual NotificationVisual

Represents the visual element of a notification. The visual element contains bindings, which contain the text and other visual content for the notification.

ScheduledTileNotification ScheduledTileNotification ScheduledTileNotification

Defines the visual content and timing for a single, non-recurring scheduled update to a tile.

ScheduledToastNotification ScheduledToastNotification ScheduledToastNotification

Contains the XML that defines the toast notification that will display at the scheduled time.

ShownTileNotification ShownTileNotification ShownTileNotification

Provides info about a tile notification that was displayed in the Start menu.

TileFlyoutNotification TileFlyoutNotification TileFlyoutNotification

Provides the details of a tile flyout (mix view) notification. This includes the notification's XML content and, optionally, its expiration time. This class also provides a method by which you can retrieve the current flyout notification's XML content.

This class is part of the following general API usage pattern:

TileFlyoutUpdateManager TileFlyoutUpdateManager TileFlyoutUpdateManager

Creates TileFlyoutUpdater objects specific to an app's primary or secondary tile, for use with a tile flyout (mix view) notification. This class also enables you to retrieve a blank tile flyout XML template to which you can add your content to define the tile flyout notification.

This class is part of the following general API usage pattern:

TileFlyoutUpdater TileFlyoutUpdater TileFlyoutUpdater

Used to send or clear a tile flyout (mix view) notification. This class also provides methods to start and stop periodic tile flyout notifications.

This class is part of the following general API usage pattern:

TileNotification TileNotification TileNotification

Defines an update to a tile, including its visuals, identification tag, and expiration time.

TileUpdateManager TileUpdateManager TileUpdateManager

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.

TileUpdateManagerForUser TileUpdateManagerForUser TileUpdateManagerForUser

Creates TileUpdater objects used to change and update Start menu tiles for a specific user. 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.

TileUpdater TileUpdater TileUpdater

Changes the content of the specific tile that the updater is bound to.

ToastActivatedEventArgs ToastActivatedEventArgs ToastActivatedEventArgs

Exposes a method that retrieves the arguments associated with a toast action initiated by the user. This lets the app tell which action was taken when multiple actions were exposed.

ToastCollection ToastCollection ToastCollection

Represents a group of notifications for a particular app.

ToastCollectionManager ToastCollectionManager ToastCollectionManager

Provides methods for creating, retrieving, updating, and removing toast collections.

ToastDismissedEventArgs ToastDismissedEventArgs ToastDismissedEventArgs

Provides the reason that a toast notification is no longer displayed on-screen.

ToastFailedEventArgs ToastFailedEventArgs ToastFailedEventArgs

Provides the error code that was generated in the process of raising a toast notification.

ToastNotification ToastNotification ToastNotification

Defines the content, associated metadata and events, and expiration time of a toast notification.

ToastNotificationActionTriggerDetail ToastNotificationActionTriggerDetail ToastNotificationActionTriggerDetail

Represents the details of a toast action trigger.

ToastNotificationHistory ToastNotificationHistory ToastNotificationHistory

Manages the toast notifications for an app including the ability the clear all toast history and removing individual toasts.

ToastNotificationHistoryChangedTriggerDetail ToastNotificationHistoryChangedTriggerDetail ToastNotificationHistoryChangedTriggerDetail

Represents the details of a toast history changed trigger.

ToastNotificationManager ToastNotificationManager ToastNotificationManager

Creates ToastNotifier objects that you use to raise toast notifications. This class also provides access to the XML content of the system-provided toast templates so that you can customize that content for use in your notifications.

ToastNotificationManagerForUser ToastNotificationManagerForUser ToastNotificationManagerForUser

Creates ToastNotifier objects that you use to raise toast notifications for the bound user. This class also provides access to the XML content of the system-provided toast templates so that you can customize that content for use in your notifications.

ToastNotifier ToastNotifier ToastNotifier

Raises a toast notification to the specific app to which the ToastNotifier is bound. This class also lets you schedule and remove toast notifications.

UserNotification UserNotification UserNotification

Represents a notification for a specific user.

UserNotificationChangedEventArgs UserNotificationChangedEventArgs UserNotificationChangedEventArgs

Provides info when a user notification changes.

Interfaces

IAdaptiveNotificationContent IAdaptiveNotificationContent IAdaptiveNotificationContent

Defines the content for an adaptive notification.

Enums

AdaptiveNotificationContentKind AdaptiveNotificationContentKind AdaptiveNotificationContentKind

Specifies the type of content contained in the adaptive notification.

BadgeTemplateType BadgeTemplateType BadgeTemplateType

Specifies the template to use for a tile's badge overlay. Used by BadgeUpdateManager.getTemplateContent.

NotificationKinds NotificationKinds NotificationKinds

Specifies the type of notification.

NotificationMirroring NotificationMirroring NotificationMirroring

Specifies whether notification mirroring is allowed. Mirroring enables a notification to be displayed on multiple devices.

NotificationSetting NotificationSetting NotificationSetting

Specifies the limitations on tile or toast notification display.

NotificationUpdateResult NotificationUpdateResult NotificationUpdateResult

Describes the results of a notification update.

PeriodicUpdateRecurrence PeriodicUpdateRecurrence PeriodicUpdateRecurrence

Specifies the time period for subsequent polls of the tile or badge data source for new content.

Used by BadgeUpdater.StartPeriodicUpdate, TileUpdater.StartPeriodicUpdate, and TileUpdater.StartPeriodicUpdateBatch.

TileFlyoutTemplateType TileFlyoutTemplateType TileFlyoutTemplateType

Specifies the layout template to use in a tile flyout (mix view) update. At present, only one template is defined.

TileTemplateType TileTemplateType TileTemplateType

Specifies the content template to use in a tile update. For a more detailed discussion of each tile, including an example of its XML coding, specifics on each template's image sizes, and use with different versions of the tile XML schema, see The tile template catalog.

When displayed on a device set to a right-to-left (RTL) language, some templates are flipped from their left and right descriptions here.

In many of the templates, the last line of text will not display if your tile includes a logo or display name. This does not apply to the large (310 x 310) tiles. For more information on the logo/short name, see Quickstart: Creating a default tile using the manifest editor.

Important

Windows 8.1 added new templates for large, square tiles. To distinguish large tiles from medium tiles (known as square tiles in Windows 8), all of the older templates were renamed. To account for this, notification payloads can be declared with a specific version. For compatibility across systems, a fallback attribute has been added so that both the old name and the new name are present. You must understand the distinctions between versions to ensure that your notifications are displayed. For more information, see Versioned templates.

When displayed on Windows Phone 8.1, some templates do not appear quite the same as they do when displayed on Windows. For instance, peek templates on the phone flip from front to back rather than scrolling up and down. The number of lines of displayed text might be different, sometimes less on the phone, but usually more. Wide tile images on the phone fill the tile with the text overlaid on them rather than having a solid colored text area. Image collection tiles are animated and appear very differently. Differences that you need to be aware of are called out for each value.

ToastDismissalReason ToastDismissalReason ToastDismissalReason

Specifies the reason that a toast notification is no longer being shown. Used with ToastDismissedEventArgs.Reason.

ToastHistoryChangedType ToastHistoryChangedType ToastHistoryChangedType

Specifies the kind of change that has happened to a notification in toast history. Used with ToastNotificationHistoryChangedTriggerDetail.ChangeType.

ToastNotificationPriority ToastNotificationPriority ToastNotificationPriority

Specifies the priority of a ToastNotification.

ToastTemplateType ToastTemplateType ToastTemplateType

Specifies the template to use in a toast notification.

UserNotificationChangedKind UserNotificationChangedKind UserNotificationChangedKind

Specifies the type of user notification change that occurred.