LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

PluginProgressUpdateArgs14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Notifications.PluginProgressUpdateArgs
Describes changes to an active progress notification. Null properties retain their current values; an empty action list removes all actions.

Constructors

PluginProgressUpdateArgs 14.1 Beta

C#
public PluginProgressUpdateArgs()
Initializes a progress update that retains all current values until replacement properties are supplied.

PluginProgressUpdateArgs 14.1 Beta

C#
public PluginProgressUpdateArgs(string message)
Initializes a progress update with a replacement message.
message 14.1 Beta
The notification message as literal text.

PluginProgressUpdateArgs 14.1 Beta

C#
public PluginProgressUpdateArgs(Unbroken.LaunchBox.Plugins.PluginText message)
Initializes a progress update with a replacement message.
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 replacement actions, or null to retain the current actions. At most three actions may be supplied.

Icon 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationIcon? Icon { get; init; }
Gets the replacement package image for supported LaunchBox surfaces, or null to retain the current image. Use Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationIcon.Default to restore the plugin's package icon, or remove the image when the package does not contain a valid icon.

Message 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.PluginText? Message { get; init; }
Gets the replacement message, or null to retain the current message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.