LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

PluginNotificationCenterArgs14.1 Beta

C#
public class Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationCenterArgs
Describes a notification to add directly to the LaunchBox notification center.

Constructors

PluginNotificationCenterArgs 14.1 Beta

C#
public PluginNotificationCenterArgs(string message)
Initializes a notification for the LaunchBox notification center.
message 14.1 Beta
The notification message as literal text.

PluginNotificationCenterArgs 14.1 Beta

C#
public PluginNotificationCenterArgs(Unbroken.LaunchBox.Plugins.PluginText message)
Initializes a notification for the LaunchBox notification center.
message 14.1 Beta
The notification message as literal or package-localized text.

Properties

Actions 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationAction> Actions { get; init; }
Gets the actions to display with the notification. At most three actions may be supplied.

Icon 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationIcon? Icon { get; init; }
Gets the package image to display in supported LaunchBox surfaces. Null uses the plugin's package icon when available; otherwise no image is displayed.

Message 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.PluginText Message { get; }
Gets the notification message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.

Severity 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationSeverity Severity { get; init; }
Gets the visual severity of the notification. The default is Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationSeverity.Information.