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

Class NotificationBuilder

Inheritance
System.Object
NotificationBuilder
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 NotificationBuilder

Constructors

| Improve this Doc View Source

NotificationBuilder()

Declaration
public NotificationBuilder()

Methods

| Improve this Doc View Source

AddText(String)

Declaration
public NotificationBuilder AddText(string text)
Parameters
Type Name Description
System.String text
Returns
Type Description
NotificationBuilder
| Improve this Doc View Source

BuildToastNotification()

Legacy method for obtaining a platform Windows.UI.Notifications.ToastNotification to use with the platform APIs or SDKs that still use the platform APIs.

Declaration
public ToastNotification BuildToastNotification()
Returns
Type Description
Windows.UI.Notifications.ToastNotification
| Improve this Doc View Source

BuildXml()

Legacy method for obtaining XML to use with the platform APIs or SDKs that still use the platform APIs.

Declaration
public XmlDocument BuildXml()
Returns
Type Description
Windows.Data.Xml.Dom.XmlDocument
| Improve this Doc View Source

InitializeFromToastNotification(ToastNotification)

Legacy method for initializing a builder using the legacy platform Windows.UI.Notifications.ToastNotification.

Declaration
public NotificationBuilder InitializeFromToastNotification(ToastNotification notif)
Parameters
Type Name Description
Windows.UI.Notifications.ToastNotification notif
Returns
Type Description
NotificationBuilder
| Improve this Doc View Source

InitializeFromXml(XmlDocument)

Legacy method for initializing a builder using the legacy platform Windows.Data.Xml.Dom.XmlDocument.

Declaration
public NotificationBuilder InitializeFromXml(XmlDocument doc)
Parameters
Type Name Description
Windows.Data.Xml.Dom.XmlDocument doc
Returns
Type Description
NotificationBuilder
| Improve this Doc View Source

Schedule(DateTimeOffset)

Schedules the notification.

Declaration
public void Schedule(DateTimeOffset deliveryTime)
Parameters
Type Name Description
System.DateTimeOffset deliveryTime
| Improve this Doc View Source

Schedule(DateTimeOffset, String)

Schedules the notification within the specified collection.

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

Schedule(DateTimeOffset, String, User)

Schedules the notification for the specified user within the specified collection.

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

Schedule(DateTimeOffset, User)

Schedules the notification for the specified user.

Declaration
public void Schedule(DateTimeOffset deliveryTime, User user)
Parameters
Type Name Description
System.DateTimeOffset deliveryTime
Windows.System.User user
| Improve this Doc View Source

Show()

Shows the notification.

Declaration
public void Show()
| Improve this Doc View Source

Show(String)

Shows the notification within the specified collection.

Declaration
public void Show(string collectionId)
Parameters
Type Name Description
System.String collectionId
| Improve this Doc View Source

Show(String, User)

Shows the notification to the specified user within the specified collection.

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

Show(User)

Shows the notification to the specified user.

Declaration
[DefaultOverload]
public void Show(User user)
Parameters
Type Name Description
Windows.System.User user
  • Improve this Doc
  • View Source
Back to top Generated by DocFX