PluginNotificationDisplayRequest14.1
Class in Unbroken.LaunchBox.Plugins.Services.Notifications
public class PluginNotificationDisplayRequest
Describes a notification to display using the user's selected notification style.
Constructors
PluginNotificationDisplayRequest(string)Initializes a notification for the user's selected display style.PluginNotificationDisplayRequest(PluginText)Initializes a notification for the user's selected display style.
PluginNotificationDisplayRequest(string)
public PluginNotificationDisplayRequest(string message)Initializes a notification for the user's selected display style.
message- The notification message as literal text.
PluginNotificationDisplayRequest(PluginText)
public PluginNotificationDisplayRequest(PluginText message)Initializes a notification for the user's selected display style.
message- The notification message as literal or package-localized text.
Properties
ActionsGets the actions to display with the LaunchBox notification. At most three actions may be supplied. Other presentation styles may expose the actions only through the notification center.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.MinimumLifeSpanGets the minimum time to keep an on-screen notification visible. Values below seven seconds are raised to seven seconds, and values above five minutes are lowered to five minutes.
Actions
public IReadOnlyList<PluginNotificationAction> Actions { get; init; }
Gets the actions to display with the LaunchBox notification. At most three actions may be supplied. Other presentation styles may expose the actions only through the notification center.
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.
MinimumLifeSpan
public TimeSpan? MinimumLifeSpan { get; init; }
Gets the minimum time to keep an on-screen notification visible. Values below seven seconds are raised to seven seconds, and values above five minutes are lowered to five minutes.