ToastCollectionManager ToastCollectionManager ToastCollectionManager ToastCollectionManager Class

Definition

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

public : sealed class ToastCollectionManager : IToastCollectionManagerpublic sealed class ToastCollectionManager : IToastCollectionManagerPublic NotInheritable Class ToastCollectionManager Implements IToastCollectionManager// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Properties

AppId AppId AppId AppId

Gets the ID of the app to which this manager belongs.

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

The ID of the app to which this manager is bound.

User User User User

Gets the user who receives the toast notification groups created by this toast collection manager.

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

The user who receives the toast notification groups.

Methods

FindAllToastCollectionsAsync() FindAllToastCollectionsAsync() FindAllToastCollectionsAsync() FindAllToastCollectionsAsync()

Starts the retrieval of all toast notification groups created by this manager.

public : IAsyncOperation<IVectorView<ToastCollection>> FindAllToastCollectionsAsync()public IAsyncOperation<IReadOnlyList<ToastCollection>> FindAllToastCollectionsAsync()Public Function FindAllToastCollectionsAsync() As IAsyncOperation( Of IReadOnlyListToastCollection )// You can use this method in JavaScript.
Returns
IAsyncOperation<IVectorView<ToastCollection>> IAsyncOperation<IReadOnlyList<ToastCollection>> IAsyncOperation<IReadOnlyList<ToastCollection>> IAsyncOperation<IReadOnlyList<ToastCollection>>

An object that represents the asynchronous operation.

GetToastCollectionAsync(String) GetToastCollectionAsync(String) GetToastCollectionAsync(String) GetToastCollectionAsync(String)

Starts the retrieval of the specified notification group.

public : IAsyncOperation<ToastCollection> GetToastCollectionAsync(PlatForm::String collectionId)public IAsyncOperation<ToastCollection> GetToastCollectionAsync(String collectionId)Public Function GetToastCollectionAsync(collectionId As String) As IAsyncOperation( Of ToastCollection )// You can use this method in JavaScript.
Parameters
collectionId
PlatForm::String String String String

The ID of the notification group to retrieve.

Returns

RemoveAllToastCollectionsAsync() RemoveAllToastCollectionsAsync() RemoveAllToastCollectionsAsync() RemoveAllToastCollectionsAsync()

Starts the asynchronous removal of all toast notification groups for the app.

public : IAsyncAction RemoveAllToastCollectionsAsync()public IAsyncAction RemoveAllToastCollectionsAsync()Public Function RemoveAllToastCollectionsAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

An object that represents the asynchronous operation.

RemoveToastCollectionAsync(String) RemoveToastCollectionAsync(String) RemoveToastCollectionAsync(String) RemoveToastCollectionAsync(String)

Starts the asynchronous removal of the specified toast notification group.

public : IAsyncAction RemoveToastCollectionAsync(PlatForm::String collectionId)public IAsyncAction RemoveToastCollectionAsync(String collectionId)Public Function RemoveToastCollectionAsync(collectionId As String) As IAsyncAction// You can use this method in JavaScript.
Parameters
collectionId
PlatForm::String String String String

The ID of toast notification group to remove.

Returns

An object that represents the asynchronous operation.

SaveToastCollectionAsync(ToastCollection) SaveToastCollectionAsync(ToastCollection) SaveToastCollectionAsync(ToastCollection) SaveToastCollectionAsync(ToastCollection)

Starts the asynchronous creation or update of the specified toast notification group.

public : IAsyncAction SaveToastCollectionAsync(ToastCollection collection)public IAsyncAction SaveToastCollectionAsync(ToastCollection collection)Public Function SaveToastCollectionAsync(collection As ToastCollection) As IAsyncAction// You can use this method in JavaScript.
Parameters
collection
ToastCollection ToastCollection ToastCollection ToastCollection

The toast notification group to create or update.

Returns

An object that represents the asynchronous operation.