Struct gio::Notification

#[repr(transparent)]
pub struct Notification { /* private fields */ }

Notification is a mechanism for creating a notification to be shown to the user – typically as a pop-up notification presented by the desktop environment shell.

The key difference between Notification and other similar APIs is that, if supported by the desktop environment, notifications sent with Notification will persist after the application has exited, and even across system reboots.

Since the user may click on a notification while the application is not running, applications using Notification should be able to be started as a D-Bus service, using Application.

In order for Notification to work, the application must have installed a .desktop file. For example:

 [Desktop Entry]
  Name=Test Application
  Comment=Description of what Test Application does
  Exec=gnome-test-application
  Icon=org.gnome.TestApplication
  Terminal=false
  Type=Application
  Categories=GNOME;GTK;TestApplication Category;
  StartupNotify=true
  DBusActivatable=true
  X-GNOME-UsesNotifications=true

The X-GNOME-UsesNotifications key indicates to GNOME Control Center that this application uses notifications, so it can be listed in the Control Center’s ‘Notifications’ panel.

The .desktop file must be named as org.gnome.TestApplication.desktop, where org.gnome.TestApplication is the ID passed to Application::new().

User interaction with a notification (either the default action, or buttons) must be associated with actions on the application (ie: “app.” actions). It is not possible to route user interaction through the notification itself, because the object will not exist if the application is autostarted as a result of a notification being clicked.

A notification can be sent with ApplicationExt::send_notification().

Implements

glib::ObjectExt

Implementations

impl Notification

pub fn new(title: &str) -> Notification

Creates a new Notification with title as its title.

After populating notification with more details, it can be sent to the desktop shell with ApplicationExt::send_notification(). Changing any properties after this call will not have any effect until resending notification.

title

the title of the notification

Returns

a new Notification instance

pub fn add_button(&self, label: &str, detailed_action: &str)

Adds a button to self that activates the action in detailed_action when clicked. That action must be an application-wide action (starting with “app.”). If detailed_action contains a target, the action will be activated with that target as its parameter.

See Action::parse_detailed_name() for a description of the format for detailed_action.

label

label of the button

detailed_action

a detailed action name

pub fn add_button_with_target_value( &self, label: &str, action: &str, target: Option<&Variant> )

Adds a button to self that activates action when clicked. action must be an application-wide action (it must start with “app.”).

If target is non-None, action will be activated with target as its parameter.

label

label of the button

action

an action name

target

a glib::Variant to use as action’s parameter, or None

pub fn set_body(&self, body: Option<&str>)

Sets the body of self to body.

body

the new body for self, or None

pub fn set_category(&self, category: Option<&str>)

Available on crate feature v2_70 only.

Sets the type of self to category. Categories have a main type like email, im or device and can have a detail separated by a ., e.g. im.received or email.arrived. Setting the category helps the notification server to select proper feedback to the user.

Standard categories are listed in the specification.

category

the category for self, or None for no category

pub fn set_default_action(&self, detailed_action: &str)

Sets the default action of self to detailed_action. This action is activated when the notification is clicked on.

The action in detailed_action must be an application-wide action (it must start with “app.”). If detailed_action contains a target, the given action will be activated with that target as its parameter. See Action::parse_detailed_name() for a description of the format for detailed_action.

When no default action is set, the application that the notification was sent on is activated.

detailed_action

a detailed action name

pub fn set_default_action_and_target_value( &self, action: &str, target: Option<&Variant> )

Sets the default action of self to action. This action is activated when the notification is clicked on. It must be an application-wide action (start with “app.”).

If target is non-None, action will be activated with target as its parameter.

When no default action is set, the application that the notification was sent on is activated.

action

an action name

target

a glib::Variant to use as action’s parameter, or None

pub fn set_icon(&self, icon: &impl IsA<Icon>)

Sets the icon of self to icon.

icon

the icon to be shown in self, as a Icon

pub fn set_priority(&self, priority: NotificationPriority)

Sets the priority of self to priority. See NotificationPriority for possible values.

priority

a NotificationPriority

pub fn set_title(&self, title: &str)

Sets the title of self to title.

title

the new title for self

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Self

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 Display for Notification

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

Formats the value using the given formatter.

impl Hash for Notification

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Notification

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Notification

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Notification

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Notification

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Notification

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Notification