LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

IPluginNotification14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Notifications.IPluginNotification
Represents a notification published through Unbroken.LaunchBox.Plugins.Notifications.INotificationManager. Added in LaunchBox 14.1.

Properties

DateRaised 14.1 Beta

C#
System.DateTimeOffset DateRaised { get; }
Gets the date and time when the notification was raised.

IsDismissed 14.1 Beta

C#
bool IsDismissed { get; }
Gets whether the notification has been dismissed or removed by the retention policy.

IsRead 14.1 Beta

C#
bool IsRead { get; }
Gets whether the notification has been marked as read.

Message 14.1 Beta

C#
string Message { get; }
Gets the message currently displayed by the notification.

Severity 14.1 Beta

C#
Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationSeverity Severity { get; }
Gets the current notification severity.

Methods

DismissAsync 14.1 Beta

C#
System.Threading.Tasks.Task DismissAsync(System.Threading.CancellationToken cancellationToken)
Removes the notification. Repeated calls have no effect.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

A task representing the dismissal request.