LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

PluginProgressCompletionArgs14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Notifications.PluginProgressCompletionArgs
Describes the final state of a progress notification.

Constructors

PluginProgressCompletionArgs 14.1 Beta

C#
public PluginProgressCompletionArgs(string message)
Initializes the final message for a completed progress notification.
message 14.1 Beta
The notification message as literal text.

PluginProgressCompletionArgs 14.1 Beta

C#
public PluginProgressCompletionArgs(Unbroken.LaunchBox.Plugins.PluginText message)
Initializes the final message for a completed progress notification.
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 replacement actions to display after the operation finishes. At most three actions may be supplied. The default empty list removes the progress actions.

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; }
Gets the final notification message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.