PluginProgressNotificationRequest14.1
Class in Unbroken.LaunchBox.Plugins.Services.Notifications
public sealed class PluginProgressNotificationRequest
Describes a progress notification to add to the LaunchBox notification center.
Constructors
PluginProgressNotificationRequest(string)Initializes a progress notification for an ongoing operation.PluginProgressNotificationRequest(PluginText)Initializes a progress notification for an ongoing operation.
PluginProgressNotificationRequest(string)
public PluginProgressNotificationRequest(string message)Initializes a progress notification for an ongoing operation.
message- The notification message as literal text.
PluginProgressNotificationRequest(PluginText)
public PluginProgressNotificationRequest(PluginText message)Initializes a progress notification for an ongoing operation.
message- The notification message as literal or package-localized text.
Properties
ActionsGets the actions to display with the progress notification. At most three actions may be supplied.IconGets the package image to display in supported LaunchBox surfaces. Null uses the plugin's package icon when available; otherwise no image is displayed.MessageGets the notification message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.
Actions
public IReadOnlyList<PluginNotificationAction> Actions { get; init; }
Gets the actions to display with the progress notification. At most three actions may be supplied.
Icon
public 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
public PluginText Message { get; }
Gets the notification message. LaunchBox collapses whitespace and truncates messages longer than 500 characters.