• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Microsoft.UI.Notifications
    • BadgeManager
    • BadgeValue
    • Notification
    • NotificationBuilder
    • NotificationCollection
    • NotificationCollectionManager
    • NotificationManager
    • PeriodicUpdateInterval

Class NotificationManager

Inheritance
System.Object
NotificationManager
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Microsoft.UI.Notifications
Assembly: Microsoft.dll
Syntax
public sealed class NotificationManager

Properties

| Improve this Doc View Source

Collections

Gets the collections manager.

Declaration
public static NotificationCollectionManager Collections { get; }
Property Value
Type Description
NotificationCollectionManager

Methods

| Improve this Doc View Source

Clear()

Clear all notifications. Note that if you're using collections, this only clears your main notifications, and not any collection notifications.

Declaration
public static void Clear()
| Improve this Doc View Source

Clear(String)

Clears all notifications within the specified collection.

Declaration
[DefaultOverload]
public static void Clear(string collectionId)
Parameters
Type Name Description
System.String collectionId
| Improve this Doc View Source

Clear(User)

Clears all notifications for the specified user.

Declaration
public static void Clear(User user)
Parameters
Type Name Description
Windows.System.User user
| Improve this Doc View Source

Clear(User, String)

Clears all notifications for the specified user within the specified collection.

Declaration
public static void Clear(User user, string collectionId)
Parameters
Type Name Description
Windows.System.User user
System.String collectionId
| Improve this Doc View Source

GetNotificationsAsync()

Gets all current notifications that are still visible to the user.

Declaration
public static IAsyncOperation<IReadOnlyList<Notification>> GetNotificationsAsync()
Returns
Type Description
Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Notification>>
| Improve this Doc View Source

GetNotificationsAsync(String)

Gets all current notifications for the specified collection that are still visible to the user.

Declaration
[DefaultOverload]
public static IAsyncOperation<IReadOnlyList<Notification>> GetNotificationsAsync(string collectionId)
Parameters
Type Name Description
System.String collectionId
Returns
Type Description
Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Notification>>
| Improve this Doc View Source

GetNotificationsAsync(String, User)

Gets all current notifications for the specified collection and user that are still visible to the user.

Declaration
public static IAsyncOperation<IReadOnlyList<Notification>> GetNotificationsAsync(string collectionId, User user)
Parameters
Type Name Description
System.String collectionId
Windows.System.User user
Returns
Type Description
Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Notification>>
| Improve this Doc View Source

GetNotificationsAsync(User)

Gets all current notifications for the specified user that are still visible to the user.

Declaration
public static IAsyncOperation<IReadOnlyList<Notification>> GetNotificationsAsync(User user)
Parameters
Type Name Description
Windows.System.User user
Returns
Type Description
Windows.Foundation.IAsyncOperation<System.Collections.Generic.IReadOnlyList<Notification>>
| Improve this Doc View Source

RemoveByTag(String)

Declaration
public static void RemoveByTag(string tag)
Parameters
Type Name Description
System.String tag
| Improve this Doc View Source

RemoveByTag(String, String)

Declaration
[DefaultOverload]
public static void RemoveByTag(string tag, string collectionId)
Parameters
Type Name Description
System.String tag
System.String collectionId
| Improve this Doc View Source

RemoveByTag(String, String, User)

Declaration
public static void RemoveByTag(string tag, string collectionId, User user)
Parameters
Type Name Description
System.String tag
System.String collectionId
Windows.System.User user
| Improve this Doc View Source

RemoveByTag(String, User)

Declaration
public static void RemoveByTag(string tag, User user)
Parameters
Type Name Description
System.String tag
Windows.System.User user
| Improve this Doc View Source

RemoveByTagAndGroup(String, String)

Declaration
public static void RemoveByTagAndGroup(string tag, string group)
Parameters
Type Name Description
System.String tag
System.String group
| Improve this Doc View Source

RemoveByTagAndGroup(String, String, String)

Declaration
[DefaultOverload]
public static void RemoveByTagAndGroup(string tag, string group, string collectionId)
Parameters
Type Name Description
System.String tag
System.String group
System.String collectionId
| Improve this Doc View Source

RemoveByTagAndGroup(String, String, String, User)

Declaration
public static void RemoveByTagAndGroup(string tag, string group, string collectionId, User user)
Parameters
Type Name Description
System.String tag
System.String group
System.String collectionId
Windows.System.User user
| Improve this Doc View Source

RemoveByTagAndGroup(String, String, User)

Declaration
public static void RemoveByTagAndGroup(string tag, string group, User user)
Parameters
Type Name Description
System.String tag
System.String group
Windows.System.User user
| Improve this Doc View Source

RemoveGroup(String)

Declaration
public static void RemoveGroup(string group)
Parameters
Type Name Description
System.String group
| Improve this Doc View Source

RemoveGroup(String, String)

Declaration
[DefaultOverload]
public static void RemoveGroup(string group, string collectionId)
Parameters
Type Name Description
System.String group
System.String collectionId
| Improve this Doc View Source

RemoveGroup(String, String, User)

Declaration
public static void RemoveGroup(string group, string collectionId, User user)
Parameters
Type Name Description
System.String group
System.String collectionId
Windows.System.User user
| Improve this Doc View Source

RemoveGroup(String, User)

Declaration
public static void RemoveGroup(string group, User user)
Parameters
Type Name Description
System.String group
Windows.System.User user
  • Improve this Doc
  • View Source
Back to top Generated by DocFX