Struct tauri::api::notification::Notification

pub struct Notification { /* private fields */ }

Available on desktop and crate feature notification only.

The desktop notification definition.

Allows you to construct a Notification data and send it.

Examples

use tauri::api::notification::Notification;
// first we build the application to access the Tauri configuration
let app = tauri::Builder::default()
  // on an actual app, remove the string argument
  .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
  .expect("error while building tauri application");

// shows a notification with the given title and body
Notification::new(&app.config().tauri.bundle.identifier)
  .title("New message")
  .body("You've got a new message.")
  .show();

// run the app
app.run(|_app_handle, _event| {});

Implementations

impl Notification

pub fn new(identifier: impl Into<String>) -> Self

Initializes a instance of a Notification.

Examples found in repository

src/endpoints/notification.rs (line 52)

  fn notification<R: Runtime>(
    context: InvokeContext<R>,
    options: NotificationOptions,
  ) -> super::Result<()> {
    let mut notification =
      Notification::new(context.config.tauri.bundle.identifier.clone()).title(options.title);
    if let Some(body) = options.body {
      notification = notification.body(body);
    }
    if let Some(icon) = options.icon {
      notification = notification.icon(icon);
    }
    #[cfg(feature = "windows7-compat")]
    {
      notification.notify(&context.window.app_handle)?;
    }
    #[cfg(not(feature = "windows7-compat"))]
    notification.show()?;
    Ok(())
  }

pub fn body(self, body: impl Into<String>) -> Self

Sets the notification body.

Examples found in repository

src/endpoints/notification.rs (line 54)

  fn notification<R: Runtime>(
    context: InvokeContext<R>,
    options: NotificationOptions,
  ) -> super::Result<()> {
    let mut notification =
      Notification::new(context.config.tauri.bundle.identifier.clone()).title(options.title);
    if let Some(body) = options.body {
      notification = notification.body(body);
    }
    if let Some(icon) = options.icon {
      notification = notification.icon(icon);
    }
    #[cfg(feature = "windows7-compat")]
    {
      notification.notify(&context.window.app_handle)?;
    }
    #[cfg(not(feature = "windows7-compat"))]
    notification.show()?;
    Ok(())
  }

pub fn title(self, title: impl Into<String>) -> Self

Sets the notification title.

Examples found in repository

src/endpoints/notification.rs (line 52)

  fn notification<R: Runtime>(
    context: InvokeContext<R>,
    options: NotificationOptions,
  ) -> super::Result<()> {
    let mut notification =
      Notification::new(context.config.tauri.bundle.identifier.clone()).title(options.title);
    if let Some(body) = options.body {
      notification = notification.body(body);
    }
    if let Some(icon) = options.icon {
      notification = notification.icon(icon);
    }
    #[cfg(feature = "windows7-compat")]
    {
      notification.notify(&context.window.app_handle)?;
    }
    #[cfg(not(feature = "windows7-compat"))]
    notification.show()?;
    Ok(())
  }

pub fn icon(self, icon: impl Into<String>) -> Self

Sets the notification icon.

Examples found in repository

src/endpoints/notification.rs (line 57)

  fn notification<R: Runtime>(
    context: InvokeContext<R>,
    options: NotificationOptions,
  ) -> super::Result<()> {
    let mut notification =
      Notification::new(context.config.tauri.bundle.identifier.clone()).title(options.title);
    if let Some(body) = options.body {
      notification = notification.body(body);
    }
    if let Some(icon) = options.icon {
      notification = notification.icon(icon);
    }
    #[cfg(feature = "windows7-compat")]
    {
      notification.notify(&context.window.app_handle)?;
    }
    #[cfg(not(feature = "windows7-compat"))]
    notification.show()?;
    Ok(())
  }

pub fn show(self) -> Result<()>

Shows the notification.

Examples

use tauri::api::notification::Notification;

// on an actual app, remove the string argument
let context = tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json");
Notification::new(&context.config().tauri.bundle.identifier)
  .title("Tauri")
  .body("Tauri is awesome!")
  .show()
  .unwrap();

Platform-specific

• Windows: Not supported on Windows 7. If your app targets it, enable the windows7-compat feature and use Self::notify.

Examples found in repository

src/api/notification.rs (line 178)

  pub fn notify<R: crate::Runtime>(self, app: &crate::AppHandle<R>) -> crate::api::Result<()> {
    #[cfg(windows)]
    {
      if crate::utils::platform::is_windows_7() {
        self.notify_win7(app)
      } else {
        #[allow(deprecated)]
        self.show()
      }
    }
    #[cfg(not(windows))]
    {
      #[allow(deprecated)]
      self.show()
    }
  }

pub fn notify<R: Runtime>(self, app: &AppHandle<R>) -> Result<()>

Available on crate feature windows7-compat only.

Shows the notification. This API is similar to Self::show, but it also works on Windows 7.

Examples

use tauri::api::notification::Notification;

// on an actual app, remove the string argument
let context = tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json");
let identifier = context.config().tauri.bundle.identifier.clone();

tauri::Builder::default()
  .setup(move |app| {
    Notification::new(&identifier)
      .title("Tauri")
      .body("Tauri is awesome!")
      .notify(&app.handle())
      .unwrap();
    Ok(())
  })
  .run(context)
  .expect("error while running tauri application");

Examples found in repository

src/endpoints/notification.rs (line 61)

  fn notification<R: Runtime>(
    context: InvokeContext<R>,
    options: NotificationOptions,
  ) -> super::Result<()> {
    let mut notification =
      Notification::new(context.config.tauri.bundle.identifier.clone()).title(options.title);
    if let Some(body) = options.body {
      notification = notification.body(body);
    }
    if let Some(icon) = options.icon {
      notification = notification.icon(icon);
    }
    #[cfg(feature = "windows7-compat")]
    {
      notification.notify(&context.window.app_handle)?;
    }
    #[cfg(not(feature = "windows7-compat"))]
    notification.show()?;
    Ok(())
  }

Trait Implementations

impl Debug for Notification

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Notification

fn default() -> Notification

Returns the “default value” for a type.