14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
PluginProgressNotificationArgs14.1 Beta
public sealed class Unbroken.LaunchBox.Plugins.Notifications.PluginProgressNotificationArgs
Describes a progress notification to add to the LaunchBox notification center.
Constructors
public PluginProgressNotificationArgs(string message)public PluginProgressNotificationArgs(Unbroken.LaunchBox.Plugins.PluginText message)
PluginProgressNotificationArgs 14.1 Beta
public PluginProgressNotificationArgs(string message)Initializes a progress notification for an ongoing operation.
message14.1 Beta- The notification message as literal text.
PluginProgressNotificationArgs 14.1 Beta
public PluginProgressNotificationArgs(Unbroken.LaunchBox.Plugins.PluginText message)Initializes a progress notification for an ongoing operation.
message14.1 Beta- The notification message as literal or package-localized text.
Properties
public System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationAction> Actions { get; init; }public Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationIcon? Icon { get; init; }public Unbroken.LaunchBox.Plugins.PluginText Message { get; }
Actions 14.1 Beta
public System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Notifications.PluginNotificationAction> Actions { get; init; }
Gets the actions to display with the progress notification. At most three actions may be supplied.
Icon 14.1 Beta
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
public Unbroken.LaunchBox.Plugins.PluginText Message { get; }
Gets the notification message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.