ToastCollection ToastCollection ToastCollection ToastCollection Class

Definition

Namespace:
Windows.UI.Notifications Windows.UI.Notifications Windows.UI.Notifications Windows.UI.Notifications
Edit

Represents a group of notifications for a particular app.

public : sealed class ToastCollection : IToastCollectionpublic sealed class ToastCollection : IToastCollectionPublic NotInheritable Class ToastCollection Implements IToastCollection// You can use this class in JavaScript.
Attributes
ActivatableAttribute ContractVersionAttribute DualApiPartitionAttribute ThreadingAttribute
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

Use a ToastCollectionManager to save, update, and remove ToastCollection objects.

Constructors

ToastCollection(String, String, String, Uri) ToastCollection(String, String, String, Uri) ToastCollection(String, String, String, Uri) ToastCollection(String, String, String, Uri)

Edit

Creates a new toast notification group.

public : ToastCollection(PlatForm::String collectionId, PlatForm::String displayName, PlatForm::String launchArgs, Uri iconUri)public ToastCollection(String collectionId, String displayName, String launchArgs, Uri iconUri)Public Sub New(collectionId As String, displayName As String, launchArgs As String, iconUri As Uri)// You can use this method in JavaScript.
Parameters
collectionId
PlatForm::String String String String

The ID of the group. You can use the ID to manipulate the group with a ToastCollectionManager

displayName
PlatForm::String String String String

The title of group to display in the Action Center.

launchArgs
PlatForm::String String String String

The launch arguments that are passed to the app when the user clicks the notification group title in the Action Center.

iconUri
Uri Uri Uri Uri

The icon to display next to the title in the Action Center.

Properties

DisplayName DisplayName DisplayName DisplayName

Edit

Gets or sets the group title that displays in the Action Center.

public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The group title that displays in the Action Center.

Icon Icon Icon Icon

Edit

Gets or sets the icon that displays next to the group title in the Action Center.

public : Uri Icon { get; set; }public Uri Icon { get; set; }Public ReadWrite Property Icon As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The icon that displays next to the group title in the Action Center.

Id Id Id Id

Edit

Gets the ID of this notification group.

public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

Remarks

Storing the ID of the notification group enables you to use the ToastCollectionManager to manipulate it later.

LaunchArgs LaunchArgs LaunchArgs LaunchArgs

Edit

Gets or sets the launch arguments provided to app when the notification group title is clicked in the Action Center.

public : PlatForm::String LaunchArgs { get; set; }public string LaunchArgs { get; set; }Public ReadWrite Property LaunchArgs As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The launch arguments provided to app when the notification group title is clicked in the Action Center.