@tauri-apps/plugin-notification - v2.3.0
    Preparing search index...

    Interface Options

    Options to send a notification.

    2.0.0

    interface Options {
        id?: number;
        channelId?: string;
        title: string;
        body?: string;
        schedule?: Schedule;
        largeBody?: string;
        summary?: string;
        actionTypeId?: string;
        group?: string;
        groupSummary?: boolean;
        sound?: string;
        inboxLines?: string[];
        icon?: string;
        largeIcon?: string;
        iconColor?: string;
        attachments?: Attachment[];
        extra?: Record<string, unknown>;
        ongoing?: boolean;
        autoCancel?: boolean;
        silent?: boolean;
        visibility?: Visibility;
        number?: number;
    }
    Index

    Properties

    id? channelId? title body? schedule? largeBody? summary? actionTypeId? group? groupSummary? sound? inboxLines? icon? largeIcon? iconColor? attachments? extra? ongoing? autoCancel? silent? visibility? number?

    Properties

    id?: number

    The notification identifier to reference this object later. Must be a 32-bit integer.

    channelId?: string

    Identifier of the Channel that deliveres this notification.

    If the channel does not exist, the notification won't fire. Make sure the channel exists with listChannels and createChannel.

    title: string

    Notification title.

    Optionalbody

    body?: string

    Optional notification body.

    schedule?: Schedule

    Schedule this notification to fire on a later time or a fixed interval.

    largeBody?: string

    Multiline text. Changes the notification style to big text. Cannot be used with inboxLines.

    summary?: string

    Detail text for the notification with largeBody, inboxLines or groupSummary.

    actionTypeId?: string

    Defines an action type for this notification.

    group?: string

    Identifier used to group multiple notifications.

    https://developer.apple.com/documentation/usernotifications/unmutablenotificationcontent/1649872-threadidentifier

    groupSummary?: boolean

    Instructs the system that this notification is the summary of a group on Android.

    sound?: string

    The sound resource name. Only available on mobile.

    inboxLines?: string[]

    List of lines to add to the notification. Changes the notification style to inbox. Cannot be used with largeBody.

    Only supports up to 5 lines.

    icon?: string

    Notification icon.

    On Android the icon must be placed in the app's res/drawable folder.

    largeIcon?: string

    Notification large icon (Android).

    The icon must be placed in the app's res/drawable folder.

    iconColor?: string

    Icon color on Android.

    attachments?: Attachment[]

    Notification attachments.

    extra?: Record<string, unknown>

    Extra payload to store in the notification.

    ongoing?: boolean

    If true, the notification cannot be dismissed by the user on Android.

    An application service must manage the dismissal of the notification. It is typically used to indicate a background task that is pending (e.g. a file download) or the user is engaged with (e.g. playing music).

    autoCancel?: boolean

    Automatically cancel the notification when the user clicks on it.

    silent?: boolean

    Changes the notification presentation to be silent on iOS (no badge, no sound, not listed).

    visibility?: Visibility

    Notification visibility.

    number?: number

    Sets the number of items this notification represents on Android.

    Settings

    Member Visibility

    On This Page

    Properties