Struct Notification

pub struct Notification { /* private fields */ }

Provides a builder API and contains relevant notification info.

Examples

use dioxus_notification::Notification;

Notification::new()
    .app_name("dioxus test".to_string())
    .summary("hi, this is dioxus test".to_string())
    .body("lorem ipsum??".to_string())
    .show()
    .unwrap();

Implementations

impl Notification

pub fn new() -> Self

Creates a new notification with empty/default values.

pub fn show(&self) -> Result<(), NotificationError>

Show the final notification.

pub fn app_name(&mut self, value: impl ToString) -> &mut Self

Set the application’s name for the notification.

pub fn summary(&mut self, value: impl ToString) -> &mut Self

Set the summary content of the notification.

pub fn body(&mut self, value: impl ToString) -> &mut Self

Set the body content of the notification.

pub fn icon_path(&mut self, value: impl AsRef<Path>) -> &mut Self

Set full path to image.

Not supported on MacOS.

pub fn timeout(&mut self, value: NotificationTimeout) -> &mut Self

Set a timeout for when the notification should hide.

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Notification

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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.