Interface INotification

interface INotification {
    active: () => Promise<ActiveNotification[]>;
    cancel: (notifications: number[]) => Promise<void>;
    cancelAll: () => Promise<void>;
    channels: () => Promise<Channel[]>;
    createChannel: (channel: Channel) => Promise<void>;
    isPermissionGranted: () => Promise<boolean>;
    onAction: (cb: (notification: Options) => void) => Promise<PluginListener>;
    onNotificationReceived: (
        cb: (notification: Options) => void,
    ) => Promise<PluginListener>;
    pending: () => Promise<PendingNotification[]>;
    registerActionTypes: (types: ActionType[]) => Promise<void>;
    removeActive: (
        notifications: { id: number; tag?: string }[],
    ) => Promise<void>;
    removeAllActive: () => Promise<void>;
    removeChannel: (id: string) => Promise<void>;
    requestPermission: () => Promise<NotificationPermission>;
    sendNotification: (options: string | Options) => void;
}

Properties

active cancel cancelAll channels createChannel isPermissionGranted onAction onNotificationReceived pending registerActionTypes removeActive removeAllActive removeChannel requestPermission sendNotification

Properties

active

active: () => Promise<ActiveNotification[]>

Type declaration

    • (): Promise<ActiveNotification[]>

    • Retrieves the list of active notifications.

      Returns Promise<ActiveNotification[]>

      A promise resolving to the list of active notifications.

      Example

      import { active } from '@tauri-apps/plugin-notification';
      const activeNotifications = await active();

      Since

      2.0.0

cancel

cancel: (notifications: number[]) => Promise<void>

Type declaration

    • (notifications: number[]): Promise<void>

    • Cancels the pending notifications with the given list of identifiers.

      Parameters

      • notifications: number[]

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { cancel } from '@tauri-apps/plugin-notification';
      await cancel([-34234, 23432, 4311]);

      Since

      2.0.0

cancelAll

cancelAll: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Cancels all pending notifications.

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { cancelAll } from '@tauri-apps/plugin-notification';
      await cancelAll();

      Since

      2.0.0

channels

channels: () => Promise<Channel[]>

Type declaration

    • (): Promise<Channel[]>

    • Retrieves the list of notification channels.

      Returns Promise<Channel[]>

      A promise resolving to the list of notification channels.

      Example

      import { channels } from '@tauri-apps/plugin-notification';
      const notificationChannels = await channels();

      Since

      2.0.0

createChannel

createChannel: (channel: Channel) => Promise<void>

Type declaration

    • (channel: Channel): Promise<void>

    • Creates a notification channel.

      Parameters

      • channel: Channel

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
      await createChannel({
        id: 'new-messages',
        name: 'New Messages',
        lights: true,
        vibration: true,
        importance: Importance.Default,
        visibility: Visibility.Private
      });

      Since

      2.0.0

isPermissionGranted

isPermissionGranted: () => Promise<boolean>

Type declaration

    • (): Promise<boolean>

    • Checks if the permission to send notifications is granted.

      Returns Promise<boolean>

      Example

      import { isPermissionGranted } from '@tauri-apps/plugin-notification';
      const permissionGranted = await isPermissionGranted();

      Since

      2.0.0

onAction

onAction: (cb: (notification: Options) => void) => Promise<PluginListener>

onNotificationReceived

onNotificationReceived: (
    cb: (notification: Options) => void,
) => Promise<PluginListener>

pending

pending: () => Promise<PendingNotification[]>

Type declaration

    • (): Promise<PendingNotification[]>

    • Retrieves the list of pending notifications.

      Returns Promise<PendingNotification[]>

      A promise resolving to the list of pending notifications.

      Example

      import { pending } from '@tauri-apps/plugin-notification';
      const pendingNotifications = await pending();

      Since

      2.0.0

registerActionTypes

registerActionTypes: (types: ActionType[]) => Promise<void>

Type declaration

    • (types: ActionType[]): Promise<void>

    • Register actions that are performed when the user clicks on the notification.

      Parameters

      • types: ActionType[]

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { registerActionTypes } from '@tauri-apps/plugin-notification';
      await registerActionTypes([{
        id: 'tauri',
        actions: [{
          id: 'my-action',
          title: 'Settings'
        }]
      }])

      Since

      2.0.0

removeActive

removeActive: (notifications: { id: number; tag?: string }[]) => Promise<void>

Type declaration

    • (notifications: { id: number; tag?: string }[]): Promise<void>

    • Removes the active notifications with the given list of identifiers.

      Parameters

      • notifications: { id: number; tag?: string }[]

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { cancel } from '@tauri-apps/plugin-notification';
      await cancel([-34234, 23432, 4311])

      Since

      2.0.0

removeAllActive

removeAllActive: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Removes all active notifications.

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { removeAllActive } from '@tauri-apps/plugin-notification';
      await removeAllActive()

      Since

      2.0.0

removeChannel

removeChannel: (id: string) => Promise<void>

Type declaration

    • (id: string): Promise<void>

    • Removes the channel with the given identifier.

      Parameters

      • id: string

      Returns Promise<void>

      A promise indicating the success or failure of the operation.

      Example

      import { removeChannel } from '@tauri-apps/plugin-notification';
      await removeChannel();

      Since

      2.0.0

requestPermission

requestPermission: () => Promise<NotificationPermission>

Type declaration

    • (): Promise<NotificationPermission>

    • Requests the permission to send notifications.

      Returns Promise<NotificationPermission>

      A promise resolving to whether the user granted the permission or not.

      Example

      import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
      let permissionGranted = await isPermissionGranted();
      if (!permissionGranted) {
        const permission = await requestPermission();
        permissionGranted = permission === 'granted';
      }

      Since

      2.0.0

sendNotification

sendNotification: (options: string | Options) => void

Type declaration

    • (options: string | Options): void

    • Sends a notification to the user.

      Parameters

      • options: string | Options

      Returns void

      Example

      import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
      let permissionGranted = await isPermissionGranted();
      if (!permissionGranted) {
        const permission = await requestPermission();
        permissionGranted = permission === 'granted';
      }
      if (permissionGranted) {
        sendNotification('Tauri is awesome!');
        sendNotification({ title: 'TAURI', body: 'Tauri is awesome!' });
      }

      Since

      2.0.0

Settings

Member Visibility

On This Page

Properties