LaunchBoxContributors
On this page

IPluginNotification14.1

Interface in Unbroken.LaunchBox.Plugins.Services.Notifications

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

Properties

  • DateRaisedGets the date and time when the notification was raised.
  • IsDismissedGets whether the notification has been dismissed or removed by the retention policy.
  • IsReadGets whether the notification has been marked as read.
  • MessageGets the message currently displayed by the notification.
  • SeverityGets the current notification severity.

DateRaised

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

IsDismissed

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

IsRead

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

Message

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

Severity

C#
PluginNotificationSeverity Severity { get; }
Gets the current notification severity.

Methods

  • DismissAsyncRemoves the notification. Repeated calls have no effect.

DismissAsync

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

Returns

A task representing the dismissal request.