Interface PlatformNotification

Data needed to display a notification to the user

interface PlatformNotification {
    clickCommand?: keyof CommandHandlers;
    clickCommandLabel?: string;
    message: string;
    notificationId?: string | number;
    severity: Severity;
}

Properties

clickCommand?: keyof CommandHandlers

Optional command to run if users click on the label in the notification

clickCommandLabel?: string

Optional label for users to click when the notification shows.

Automatically localized if this is a LocalizeKey.

message: string

Text to display to the user.

Automatically localized if this is a LocalizeKey.

notificationId?: string | number

Optional ID of a previous notification to update instead of showing a new notification

severity: Severity

Severity of the notification