LaunchBoxContributors
On this page

PluginNotificationCenterRequest14.1

Class in Unbroken.LaunchBox.Plugins.Services.Notifications

C#
public class PluginNotificationCenterRequest
Describes a notification to add directly to the LaunchBox notification center.

Constructors

PluginNotificationCenterRequest(string)

C#
public PluginNotificationCenterRequest(string message)
Initializes a notification for the LaunchBox notification center.
message
The notification message as literal text.

PluginNotificationCenterRequest(PluginText)

C#
public PluginNotificationCenterRequest(PluginText message)
Initializes a notification for the LaunchBox notification center.
message
The notification message as literal or package-localized text.

Properties

  • ActionsGets the actions to display with the 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.
  • SeverityGets the visual severity of the notification. The default is PluginNotificationSeverity.Information.

Actions

C#
public IReadOnlyList<PluginNotificationAction> Actions { get; init; }
Gets the actions to display with the notification. At most three actions may be supplied.

Icon

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

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

Severity

C#
public PluginNotificationSeverity Severity { get; init; }
Gets the visual severity of the notification. The default is PluginNotificationSeverity.Information.