LaunchBoxContributors
On this page

PluginProgressCompletionRequest14.1

Class in Unbroken.LaunchBox.Plugins.Services.Notifications

C#
public sealed class PluginProgressCompletionRequest
Describes the final state of a progress notification.

Constructors

PluginProgressCompletionRequest(string)

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

PluginProgressCompletionRequest(PluginText)

C#
public PluginProgressCompletionRequest(PluginText message)
Initializes the final message for a completed progress notification.
message
The notification message as literal or package-localized text.

Properties

  • ActionsGets the replacement actions to display after the operation finishes. At most three actions may be supplied. The default empty list removes the progress actions.
  • IconGets the replacement package image for supported LaunchBox surfaces, or null to retain the current image. Use PluginNotificationIcon.Default to restore the plugin's package icon, or remove the image when the package does not contain a valid icon.
  • MessageGets the final notification message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.

Actions

C#
public IReadOnlyList<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

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

Message

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