Struct Notification

pub struct Notification<'a> { /* private fields */ }

Options to further customize the notification

Implementations

impl<'a> Notification<'a>

pub fn new() -> Self

Create a Notification to further customize the notification

pub fn title(&mut self, title: &'a str) -> &mut Self

Set title field

pub fn subtitle(&mut self, subtitle: &'a str) -> &mut Self

Set subtitle field

pub fn maybe_subtitle(&mut self, subtitle: Option<&'a str>) -> &mut Self

Set subtitle field

pub fn message(&mut self, message: &'a str) -> &mut Self

Set message field

pub fn main_button(&mut self, main_button: MainButton<'a>) -> &mut Self

Allow actions through a main button

Example:

let _ = Notification::new().main_button(MainButton::SingleAction("Main button"));

pub fn close_button(&mut self, close_button: &'a str) -> &mut Self

Display a close button with the given name

Example:

let _ = Notification::new().close_button("Close");

pub fn app_icon(&mut self, app_icon: &'a str) -> &mut Self

Display an icon on the left side of the notification

NOTE: The icon of the app associated to the bundle will be displayed next to the notification title

Example:

let _ = Notification::new().app_icon("/path/to/icon.icns");

pub fn content_image(&mut self, content_image: &'a str) -> &mut Self

Display an image on the right side of the notification

Example:

let _ = Notification::new().content_image("/path/to/image.png");

pub fn delivery_date(&mut self, delivery_date: f64) -> &mut Self

Schedule the notification to be delivered at a later time

Example:

let stamp = time::OffsetDateTime::now_utc().unix_timestamp() as f64 + 5.;
let _ = Notification::new().delivery_date(stamp);

pub fn default_sound(&mut self) -> &mut Self

Play the default sound "NSUserNotificationDefaultSoundName" system sound when the notification is delivered.

Example:

let _ = Notification::new().default_sound();

pub fn sound<S>(&mut self, sound: S) -> &mut Self

where S: Into<Sound>,

Play a system sound when the notification is delivered. Use Sound::Default to play the default sound.

Example:

let _ = Notification::new().sound("Blow");

pub fn maybe_sound<S>(&mut self, sound: Option<S>) -> &mut Self

where S: Into<Sound>,

Play a system sound when the notification is delivered. Use Sound::Default to play the default sound.

Example:

let _ = Notification::new().sound("Blow");

pub fn asynchronous(&mut self, asynchronous: bool) -> &mut Self

Deliver the notification asynchronously (without waiting for an interaction).

Note: Setting this to true is equivalent to a fire-and-forget.

Example:

let _ = Notification::new().asynchronous(true);

pub fn send(&self) -> NotificationResult<NotificationResponse>

Delivers a new notification

Returns a NotificationError if a notification could not be delivered

Trait Implementations

impl<'a> Clone for Notification<'a>

fn clone(&self) -> Notification<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for Notification<'a>

fn default() -> Notification<'a>

Returns the “default value” for a type.