1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
//! # Examples
//!
//! ```rust,no_run
//! use std::{thread, time};
//!
//! use ashpd::desktop::{
//! notification::{Action, Button, Notification, NotificationProxy, Priority},
//! Icon,
//! };
//! use futures_util::StreamExt;
//! use zbus::zvariant::Value;
//!
//! async fn run() -> ashpd::Result<()> {
//! let proxy = NotificationProxy::new().await?;
//!
//! let notification_id = "org.gnome.design.Contrast";
//! proxy
//! .add_notification(
//! notification_id,
//! Notification::new("Contrast")
//! .default_action("open")
//! .default_action_target(100)
//! .body("color copied to clipboard")
//! .priority(Priority::High)
//! .icon(Icon::with_names(&["dialog-question-symbolic"]))
//! .button(Button::new("Copy", "copy").target(32))
//! .button(Button::new("Delete", "delete").target(40)),
//! )
//! .await?;
//!
//! let action = proxy
//! .receive_action_invoked()
//! .await?
//! .next()
//! .await
//! .expect("Stream exhausted");
//! match action.name() {
//! "copy" => (), // Copy something to clipboard
//! "delete" => (), // Delete the file
//! _ => (),
//! };
//! println!("{:#?}", action.id());
//! println!(
//! "{:#?}",
//! action.parameter().get(0).unwrap().downcast_ref::<u32>()
//! );
//!
//! proxy.remove_notification(notification_id).await?;
//! Ok(())
//! }
//! ```
use std::{fmt, str::FromStr};
use futures_util::Stream;
use serde::{self, Deserialize, Serialize};
use zbus::zvariant::{OwnedValue, SerializeDict, Type, Value};
use super::Icon;
use crate::{proxy::Proxy, Error};
#[cfg_attr(feature = "glib", derive(glib::Enum))]
#[cfg_attr(feature = "glib", enum_type(name = "AshpdPriority"))]
#[derive(Debug, Copy, Clone, Serialize, PartialEq, Eq, Type)]
#[zvariant(signature = "s")]
#[serde(rename_all = "lowercase")]
/// The notification priority
pub enum Priority {
/// Low.
Low,
/// Normal.
Normal,
/// High.
High,
/// Urgent.
Urgent,
}
impl fmt::Display for Priority {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Low => write!(f, "Low"),
Self::Normal => write!(f, "Normal"),
Self::High => write!(f, "High"),
Self::Urgent => write!(f, "Urgent"),
}
}
}
impl AsRef<str> for Priority {
fn as_ref(&self) -> &str {
match self {
Self::Low => "Low",
Self::Normal => "Normal",
Self::High => "High",
Self::Urgent => "Urgent",
}
}
}
impl From<Priority> for &'static str {
fn from(d: Priority) -> Self {
match d {
Priority::Low => "Low",
Priority::Normal => "Normal",
Priority::High => "High",
Priority::Urgent => "Urgent",
}
}
}
impl FromStr for Priority {
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"Low" | "low" => Ok(Priority::Low),
"Normal" | "normal" => Ok(Priority::Normal),
"High" | "high" => Ok(Priority::High),
"Urgent" | "urgent" => Ok(Priority::Urgent),
_ => Err(Error::ParseError("Failed to parse priority, invalid value")),
}
}
}
#[derive(SerializeDict, Type, Debug)]
/// A notification
#[zvariant(signature = "dict")]
pub struct Notification {
/// User-visible string to display as the title.
title: String,
/// User-visible string to display as the body.
body: Option<String>,
/// Serialized icon (e.g using gio::Icon::serialize).
icon: Option<Icon>,
/// The priority for the notification.
priority: Option<Priority>,
/// Name of an action that is exported by the application.
/// This action will be activated when the user clicks on the notification.
#[zvariant(rename = "default-action")]
default_action: Option<String>,
/// Target parameter to send along when activating the default action.
#[zvariant(rename = "default-action-target")]
default_action_target: Option<OwnedValue>,
/// Array of buttons to add to the notification.
buttons: Option<Vec<Button>>,
}
impl Notification {
/// Create a new notification.
///
/// # Arguments
///
/// * `title` - the notification title.
pub fn new(title: &str) -> Self {
Self {
title: title.to_owned(),
body: None,
priority: None,
icon: None,
default_action: None,
default_action_target: None,
buttons: None,
}
}
/// Sets the notification body.
#[must_use]
pub fn body<'a>(mut self, body: impl Into<Option<&'a str>>) -> Self {
self.body = body.into().map(ToOwned::to_owned);
self
}
/// Sets an icon to the notification.
#[must_use]
pub fn icon(mut self, icon: impl Into<Option<Icon>>) -> Self {
self.icon = icon.into();
self
}
/// Sets the notification priority.
#[must_use]
pub fn priority(mut self, priority: impl Into<Option<Priority>>) -> Self {
self.priority = priority.into();
self
}
/// Sets the default action when the user clicks on the notification.
#[must_use]
pub fn default_action<'a>(mut self, default_action: impl Into<Option<&'a str>>) -> Self {
self.default_action = default_action.into().map(ToOwned::to_owned);
self
}
/// Sets a value to be sent in the `action_invoked` signal.
#[must_use]
pub fn default_action_target<'a, T: Into<Value<'a>>>(
mut self,
default_action_target: impl Into<Option<T>>,
) -> Self {
self.default_action_target = default_action_target
.into()
.map(|t| t.into().try_to_owned().unwrap());
self
}
/// Adds a new button to the notification.
#[must_use]
pub fn button(mut self, button: Button) -> Self {
match self.buttons {
Some(ref mut buttons) => buttons.push(button),
None => {
self.buttons.replace(vec![button]);
}
};
self
}
}
#[derive(SerializeDict, Type, Debug)]
/// A notification button
#[zvariant(signature = "dict")]
pub struct Button {
/// User-visible label for the button. Mandatory.
label: String,
/// Name of an action that is exported by the application. The action will
/// be activated when the user clicks on the button.
action: String,
/// Target parameter to send along when activating the action.
target: Option<OwnedValue>,
}
impl Button {
/// Create a new notification button.
///
/// # Arguments
///
/// * `label` - the user visible label of the button.
/// * `action` - the action name to be invoked when the user clicks on the
/// button.
pub fn new(label: &str, action: &str) -> Self {
Self {
label: label.to_owned(),
action: action.to_owned(),
target: None,
}
}
/// The value to send with the action name when the button is clicked.
#[must_use]
pub fn target<'a, T: Into<Value<'a>>>(mut self, target: impl Into<Option<T>>) -> Self {
self.target = target.into().map(|t| t.into().try_to_owned().unwrap());
self
}
}
#[derive(Debug, Deserialize, Type)]
/// An invoked action.
pub struct Action(String, String, Vec<OwnedValue>);
impl Action {
/// Notification ID.
pub fn id(&self) -> &str {
&self.0
}
/// Action name.
pub fn name(&self) -> &str {
&self.1
}
/// The parameters passed to the action.
pub fn parameter(&self) -> &Vec<OwnedValue> {
&self.2
}
}
/// The interface lets sandboxed applications send and withdraw notifications.
///
/// It is not possible for the application to learn if the notification was
/// actually presented to the user. Not a portal in the strict sense, since
/// there is no user interaction.
///
/// **Note** in contrast to most other portal requests, notifications are
/// expected to outlast the running application. If a user clicks on a
/// notification after the application has exited, it will get activated again.
///
/// Notifications can specify actions that can be activated by the user.
/// Actions whose name starts with 'app.' are assumed to be exported and will be
/// activated via the ActivateAction() method in the org.freedesktop.Application
/// interface. Other actions are activated by sending the
/// `#org.freedeskop.portal.Notification::ActionInvoked` signal to the
/// application.
///
/// Wrapper of the DBus interface: [`org.freedesktop.portal.Notification`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Notification.html).
#[derive(Debug)]
#[doc(alias = "org.freedesktop.portal.Notification")]
pub struct NotificationProxy<'a>(Proxy<'a>);
impl<'a> NotificationProxy<'a> {
/// Create a new instance of [`NotificationProxy`].
pub async fn new() -> Result<NotificationProxy<'a>, Error> {
let proxy = Proxy::new_desktop("org.freedesktop.portal.Notification").await?;
Ok(Self(proxy))
}
/// Signal emitted when a particular action is invoked.
///
/// # Specifications
///
/// See also [`ActionInvoked`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Notification.html#org-freedesktop-portal-notification-actioninvoked).
#[doc(alias = "ActionInvoked")]
#[doc(alias = "XdpPortal::notification-action-invoked")]
pub async fn receive_action_invoked(&self) -> Result<impl Stream<Item = Action>, Error> {
self.0.signal("ActionInvoked").await
}
/// Sends a notification.
///
/// The ID can be used to later withdraw the notification.
/// If the application reuses the same ID without withdrawing, the
/// notification is replaced by the new one.
///
/// # Arguments
///
/// * `id` - Application-provided ID for this notification.
/// * `notification` - The notification.
///
/// # Specifications
///
/// See also [`AddNotification`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Notification.html#org-freedesktop-portal-notification-addnotification).
#[doc(alias = "AddNotification")]
#[doc(alias = "xdp_portal_add_notification")]
pub async fn add_notification(
&self,
id: &str,
notification: Notification,
) -> Result<(), Error> {
self.0.call("AddNotification", &(id, notification)).await
}
/// Withdraws a notification.
///
/// # Arguments
///
/// * `id` - Application-provided ID for this notification.
///
/// # Specifications
///
/// See also [`RemoveNotification`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Notification.html#org-freedesktop-portal-notification-removenotification).
#[doc(alias = "RemoveNotification")]
#[doc(alias = "xdp_portal_remove_notification")]
pub async fn remove_notification(&self, id: &str) -> Result<(), Error> {
self.0.call("RemoveNotification", &(id)).await
}
}
impl<'a> std::ops::Deref for NotificationProxy<'a> {
type Target = zbus::Proxy<'a>;
fn deref(&self) -> &Self::Target {
&self.0
}
}