RAGS - v1.10.0
    Preparing search index...

    Interface NotificationArgs

    Options for sending a desktop notification.

    interface NotificationArgs {
        actionIcons?: boolean;
        actions?: { [label: string]: () => void };
        appName?: string;
        body?: string;
        category?: string;
        desktopEntry?: string;
        iconName?: string;
        id?: number;
        image?: string;
        onClosed?: (
            reason: "closed" | "unset" | "timeout" | "dismissed" | "undefined",
        ) => void;
        resident?: boolean;
        soundFile?: string;
        soundName?: string;
        summary?: string;
        suppressSound?: boolean;
        timeout?: number;
        transient?: boolean;
        urgency?: Urgency;
        x?: number;
        y?: number;
    }
    Index

    Properties

    actionIcons? actions? appName? body? category? desktopEntry? iconName? id? image? onClosed? resident? soundFile? soundName? summary? suppressSound? timeout? transient? urgency? x? y?

    Properties

    actionIcons?: boolean

    Whether to use action icons.

    actions?: { [label: string]: () => void }

    Map of action label to callback.

    appName?: string

    Application name shown in the notification.

    Optionalbody

    body?: string

    Notification body text.

    category?: string

    Notification category string.

    desktopEntry?: string

    Desktop entry name hint.

    iconName?: string

    Icon name for the notification.

    id?: number

    Notification ID for replacing existing notifications.

    image?: string

    Image path hint.

    onClosed?: (
        reason: "closed" | "unset" | "timeout" | "dismissed" | "undefined",
    ) => void

    Callback when the notification is closed.

    resident?: boolean

    Whether the notification is resident (stays until dismissed).

    soundFile?: string

    Sound file path hint.

    soundName?: string

    Sound name hint.

    summary?: string

    Notification summary/title.

    suppressSound?: boolean

    Whether to suppress the notification sound.

    timeout?: number

    Timeout in milliseconds (0 for no auto-close).

    transient?: boolean

    Whether the notification is transient.

    urgency?: Urgency

    Urgency level: 'low', 'normal', or 'critical'.

    x?: number

    X position hint for the notification.

    y?: number

    Y position hint for the notification.

    Settings

    Member Visibility

    On This Page

    Properties