Struct Notification 

pub struct Notification<R: Runtime>(/* private fields */);

Access to the notification APIs.

You can get an instance of this type via NotificationExt

Implementations

impl<R: Runtime> Notification<R>

pub fn builder(&self) -> NotificationBuilder<R>

Creates a new builder for a notification.

Examples

use tauri_plugin_notification::NotificationExt;

fn notify<R: tauri::Runtime>(app: &tauri::AppHandle<R>) {
  app.notification()
    .builder()
    .title("Tauri")
    .body("Tauri is awesome!")
    .show()
    .unwrap();
}

pub fn request_permission(&self) -> Result<PermissionState>

Requests the permission to send notifications, prompting the user when it was not decided yet.

On Android this requests the POST_NOTIFICATIONS runtime permission.

pub fn permission_state(&self) -> Result<PermissionState>

Checks the current state of the permission to send notifications without prompting the user.

pub fn register_action_types(&self, types: Vec<ActionType>) -> Result<()>

Registers the action types a notification can reference through NotificationBuilder::action_type_id.

Platform-specific

• Android: only the identifier, title and input flag of each Action are used.
• iOS: each action type is registered as a UNNotificationCategory.

pub fn on_action<F: Fn(&ActionPerformed) + Send + Sync + 'static>( &self, handler: F, ) -> Result<()>

Calls handler for every action the user performs on a notification of this app: a tap on the notification itself (tap) or on one of its actions.

Errors

Returns an error when the listener could not be registered with the mobile plugin.

pub fn remove_active(&self, notifications: Vec<i32>) -> Result<()>

Removes the delivered notifications with the given identifiers from the notification center.

Use Self::remove_all_active to remove every delivered notification.

pub fn active(&self) -> Result<Vec<ActiveNotification>>

Lists the notifications that were delivered and are still visible in the notification center.

pub fn remove_all_active(&self) -> Result<()>

Removes all delivered notifications from the notification center.

pub fn pending(&self) -> Result<Vec<PendingNotification>>

Lists the scheduled notifications that have not been delivered yet.

pub fn cancel(&self, notifications: Vec<i32>) -> Result<()>

Cancel pending notifications.

pub fn cancel_all(&self) -> Result<()>

Cancel all pending notifications.

pub fn create_channel(&self, channel: Channel) -> Result<()>

Creates a notification channel, which notifications can target through NotificationBuilder::channel_id.

Notifications that reference a channel that does not exist are not delivered.

Only available on Android.

pub fn delete_channel(&self, id: impl Into<String>) -> Result<()>

Deletes the notification channel with the given identifier.

Only available on Android.

pub fn list_channels(&self) -> Result<Vec<Channel>>

Lists the notification channels that are currently registered for the app.

Only available on Android.