Struct Notification 

pub struct Notification { /* private fields */ }

One notification, built and then posted.

Notification::new("Session finished")
    .body("refactor-parser: 214 tests passed")
    .key(format!("session/{id}"))
    .channel("Sessions")
    .presentation(NotificationPresentation::WhenInactive)
    .post();

Nothing here names the application or its icon. The platform puts those on from the application’s own bundle, which is where the window’s icon comes from as well.

Implementations

impl Notification

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

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

The text under the title.

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

The application’s own name for this notification.

Posting again under the same key replaces the one already showing, so a session whose state keeps changing has one notification that is kept current rather than a pile of them. The key is also what comes back when the user presses it, and what withdraw_notification takes.

Without one the Renderer names it, and a notification named that way can be neither replaced nor withdrawn.

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

The group the user can turn off on its own, in the application’s own words.

Android lists these in its settings, so the name is something a person reads. Empty is the application’s default group. A platform without groups ignores it.

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

The first button. Pressing it reports action 1, and does not bring the window up: a button on a notification exists to be dealt with without opening anything.

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

The second button, which reports action 2. Two is the most every platform shows the same way.

pub fn importance(self, importance: NotificationImportance) -> Self

How much this matters. What that is worth in sound or in getting through Do Not Disturb is the platform’s answer.

pub fn presentation(self, presentation: NotificationPresentation) -> Self

Whether it is shown while the application’s window is the active one.

pub fn post(self)

Hands the notification over.

From a component or an event handler it goes out with the batch that call produces. From any other thread it waits in the Host and the Host asks for a frame, which is what NotificationSender::post does as well.

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Self

Returns a duplicate 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 Eq for Notification

impl PartialEq for Notification

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Notification