Microsoft.Toolkit.Uwp.Notifications Namespace

Classes

AdaptiveGroup

Groups semantically identify that the content in the group must either be displayed as a whole, or not displayed if it cannot fit. Groups also allow creating multiple columns. Supported on Tiles since RTM. Supported on Toasts since Anniversary Update.

AdaptiveImage

An inline image.

AdaptiveProgressBar

New in Creators Update: A progress bar. Only supported on toasts on Desktop, build 15007 or newer.

AdaptiveProgressBarValue

A class that represents the progress bar's value.

AdaptiveSubgroup

Subgroups are vertical columns that can contain text and images. Supported on Tiles since RTM. Supported on Toasts since Anniversary Update.

AdaptiveText

An adaptive text element.

BadgeGlyphContent

Notification content object to display a glyph on a Tile's badge.

BadgeNumericContent

Notification content object to display a number on a Tile's badge.

BindableProgressBarValue

A binding value for doubles.

BindableString

A binding value for strings.

DesktopNotificationHistoryCompat

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

DesktopNotificationManagerCompat

Helper for .NET Framework applications to display toast notifications and respond to toast events

NotificationActivator

Apps must implement this activator to handle notification activation.

NotificationUserInput

Text and selection values that the user entered on your notification. The Key is the ID of the input, and the Value is what the user entered.

TileBackgroundImage

A full-bleed background image that appears beneath the Tile content.

TileBasicImage

An image used on various special templates for the Tile.

TileBasicText

A text element on the Tile.

TileBinding

The binding element contains the visual content for a specific Tile size.

TileBindingContentAdaptive

Supported on all sizes. This is the recommended way of specifying your Tile content. Adaptive Tile templates are the de-facto choice for Windows 10, and you can create a wide variety of custom Tiles through adaptive.

TileBindingContentContact

Phone-only. Supported on Small, Medium, and Wide.

TileBindingContentIconic

Supported on Small and Medium. Enables an iconic Tile template, where you can have an icon and badge display next to each other on the Tile, in true classic Windows Phone style. The number next to the icon is achieved through a separate badge notification.

TileBindingContentPeople

New in 1511: Supported on Medium, Wide, and Large (Desktop and Mobile). Previously for RTM: Phone-only. Supported on Medium and Wide.

TileBindingContentPhotos

Animates through a slide show of photos. Supported on all sizes.

TileContent

Base Tile element, which contains a single visual element.

TileContentBuilder

Builder class used to create TileContent

TilePeekImage

A peek image that animates in from the top of the Tile.

TileVisual

Contains multiple binding child elements, each of which defines a Tile.

ToastActionsCustom

Create your own custom actions, using controls like ToastButton, ToastTextBox, and ToastSelectionBox.

ToastActionsSnoozeAndDismiss

Automatically constructs a selection box for snooze intervals, and snooze/dismiss buttons, all automatically localized, and snoozing logic is automatically handled by the system.

ToastActivationOptions

New in Creators Update: Additional options relating to activation.

ToastArguments

A class that supports serializing simple key/value pairs into a format that's friendly for being used within toast notifications. The serialized format is similar to a query string, however optimized for being placed within an XML property (uses semicolons instead of ampersands since those don't need to be XML-escaped, doesn't url-encode all special characters since not being used within a URL, etc).

ToastAudio

Specify audio to be played when the Toast notification is received.

ToastBindingGeneric

Generic Toast binding, where you provide text, images, and other visual elements for your Toast notification.

ToastBindingShoulderTap

Specifies content you want to appear in a My People shoulder tap notification. For more info, see the My People notifications documentation. New in Fall Creators Update.

ToastButton

A button that the user can click on a Toast notification.

ToastButtonDismiss

A button that, when clicked, is interpreted as a "dismiss" by the system, and the Toast is dismissed just like if the user swiped the Toast away.

ToastButtonSnooze

A system-handled snooze button that automatically handles snoozing of a Toast notification.

ToastContent

Base Toast element, which contains at least a visual element.

ToastContentBuilder

Builder class used to create ToastContent

ToastContextMenuItem

A Toast context menu item.

ToastGenericAppLogo

The logo that is displayed on your Toast notification.

ToastGenericAttributionText

Defines an attribution text element to be displayed on the Toast notification.

ToastGenericHeroImage

A hero image for the Toast notification.

ToastHeader

Defines a visual header for the toast notification.

ToastNotificationActivatedEventArgsCompat

Provides information about an event that occurs when the app is activated because a user tapped on the body of a toast notification or performed an action inside a toast notification.

ToastNotificationHistoryCompat

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

ToastNotificationManagerCompat

Provides access to sending and managing toast notifications. Works for all types of apps, even Win32 non-MSIX/sparse apps.

ToastNotifierCompat

Allows you to show and schedule toast notifications.

ToastPeople

Specify what person this toast is related to. For more info, see the My People documentation. New in Fall Creators Update.

ToastSelectionBox

A selection box control, which lets users pick from a dropdown list of options.

ToastSelectionBoxItem

A selection box item (an item that the user can select from the drop down list).

ToastShoulderTapImage

Specifies the image to be displayed on a My People shoulder tap notification. New in Fall Creators Update.

ToastSpriteSheet

Specifies a sprite sheet. New in Fall Creators Update.

ToastTextBox

A text box control on the Toast that a user can type text into.

ToastVisual

Defines the visual aspects of a Toast notification.

Structs

NotificationActivator.NOTIFICATION_USER_INPUT_DATA

A single user input key/value pair.

Interfaces

IAdaptiveChild

Elements that can be direct children of adaptive content, including (AdaptiveText, AdaptiveImage, and AdaptiveGroup).

IAdaptiveSubgroupChild

Elements that can be direct children of an AdaptiveSubgroup, including (AdaptiveText and AdaptiveImage).

IBaseImage

Contains the base properties that an image needs.

IBaseText

Defines the basic properties of a text element.

INotificationContent

Base notification content interface to retrieve notification Xml as a string.

ITileBindingContent

Visual Tile content. One of TileBindingContentAdaptive, TileBindingContentIconic, TileBindingContentPhotos, TileBindingContentPeople, or TileBindingContentContact.

ITileBindingContentAdaptiveChild

Elements that can be direct children of TileBindingContentAdaptive, including (AdaptiveText, AdaptiveImage, and AdaptiveGroup).

IToastActions

Actions to display on a Toast notification. One of ToastActionsCustom or ToastActionsSnoozeAndDismiss.

IToastBindingGenericChild

Elements that can be direct children of ToastBindingGeneric, including (AdaptiveText, AdaptiveImage, and AdaptiveGroup).

IToastButton

One of ToastButton, ToastButtonSnooze, or ToastButtonDismiss.

IToastInput

An input element on a Toast notification. One of ToastTextBox or ToastSelectionBox.

NotificationActivator.INotificationActivationCallback

The COM callback that is triggered when your notification is clicked.

Enums

AdaptiveImageAlign

Specifies the horizontal alignment for an image.

AdaptiveImageCrop

Specify the desired cropping of the image.

AdaptiveSubgroupTextStacking

TextStacking specifies the vertical alignment of content.

AdaptiveTextAlign

Controls the horizontal alignment of text.

AdaptiveTextStyle

Text style controls font size, weight, and opacity.

BadgeGlyphValue

The types of glyphs that can be placed on a badge.

TileBackgroundImageCrop

Specify the desired cropping of the image.

TileBranding

The form that the Tile should use to display the app's brand.

TilePeekImageCrop

Specify the desired cropping of the image.

TileSize

Represent the all tile sizes that are available.

TileTextStacking

TextStacking specifies the vertical alignment of content.

ToastActivationType

Decides the type of activation that will be used when the user interacts with the Toast notification.

ToastAfterActivationBehavior

Specifies the behavior that the toast should use when the user takes action on the toast.

ToastDuration

The amount of time the Toast should display.

ToastGenericAppLogoCrop

Specify the desired cropping of the image.

ToastImageCrop

Specify the desired cropping of the image.

ToastScenario

Specifies the scenario, controlling behaviors about the Toast.

Delegates

CustomizeScheduledToast

Allows you to set additional properties on the Windows.UI.Notifications.ScheduledToastNotification object before the toast is scheduled.

CustomizeScheduledToastAsync

Allows you to set additional properties on the Windows.UI.Notifications.ScheduledToastNotification object before the toast is scheduled.

CustomizeToast

Allows you to set additional properties on the Windows.UI.Notifications.ToastNotification object before the toast is displayed.

CustomizeToastAsync

Allows you to set additional properties on the Windows.UI.Notifications.ToastNotification object before the toast is displayed.

OnActivated

Event triggered when a notification is clicked.