LaunchBoxContributors
On this page

PluginProgressUpdateRequest14.1

Class in Unbroken.LaunchBox.Plugins.Services.Notifications

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

Constructors

PluginProgressUpdateRequest()

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

PluginProgressUpdateRequest(string)

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

PluginProgressUpdateRequest(PluginText)

C#
public PluginProgressUpdateRequest(PluginText message)
Initializes a progress update with a replacement message.
message
The notification message as literal or package-localized text.

Properties

  • ActionsGets replacement actions, or null to retain the current actions. At most three actions may be supplied.
  • 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 replacement message, or null to retain the current message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.

Actions

C#
public IReadOnlyList<PluginNotificationAction>? Actions { get; init; }
Gets replacement actions, or null to retain the current actions. At most three actions may be supplied.

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; init; }
Gets the replacement message, or null to retain the current message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.