LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

PluginNotificationDisplayArgs14.1 Beta

C#
public class Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationDisplayArgs
Describes a notification to display using the user's selected notification style.

Constructors

PluginNotificationDisplayArgs 14.1 Beta

C#
public PluginNotificationDisplayArgs(string message)
Initializes a notification for the user's selected display style.
message 14.1 Beta
The notification message as literal text.

PluginNotificationDisplayArgs 14.1 Beta

C#
public PluginNotificationDisplayArgs(Unbroken.LaunchBox.Plugins.PluginText message)
Initializes a notification for the user's selected display style.
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 LaunchBox notification. At most three actions may be supplied. Other presentation styles may expose the actions only through the notification center.

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.

MinimumLifeSpan 14.1 Beta

C#
public System.TimeSpan? MinimumLifeSpan { get; init; }
Gets the minimum time to keep an on-screen notification visible. Values below seven seconds are raised to seven seconds, and values above five minutes are lowered to five minutes.