papi-dts
    Preparing search index...

    Interface PlatformNotification

    Data needed to display a notification to the user

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

    Properties

    clickCommand? clickCommandLabel? duration? message notificationId? severity

    Properties

    clickCommand?: keyof CommandHandlers

    Optional command to run if users click on the label in the notification. The command will be sent one argument:

    • NotificationId: The ID of the notification that was clicked

    The command handler should have the type signature NotificationClickCommandHandler.

    clickCommandLabel?: string

    Optional label for users to click when the notification shows.

    Automatically localized if this is a LocalizeKey.

    duration?: number

    Optional duration in milliseconds for how long the notification is displayed. To make the notification show indefinitely, specify a duration of 0 or less.

    When omitted, duration is computed from message length (minimum 10 seconds, maximum 35 seconds).

    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

    Settings

    Member Visibility

    On This Page

    Properties