Struct prowl::Notification

pub struct Notification { /* private fields */ }

Creates a notification in memory to be sent via prowl.

Implementations

impl Notification

pub fn priority(&self) -> &Option<Priority>

pub fn url(&self) -> &Option<String>

pub fn application(&self) -> &String

pub fn event(&self) -> &String

pub fn description(&self) -> &String

impl Notification

pub fn new(
    api_keys: Vec<String>,
    priority: Option<Priority>,
    url: Option<String>,
    application: String,
    event: String,
    description: String
) -> Result<Self, CreationError>

Creates a new Notification in memory that can be sent via add.

Examples

Create a new notification and send it via add,

let application = "My fancy app".to_string();
let notification_title = "Meet Single Crabs in your Area!".to_string();
let notification_description = "Zero-cost abstractions are waiting for your to claim them!".to_string();
let notification = prowl::Notification::new(
   vec!["MY-API-KEY".to_string()],
   Some(prowl::Priority::VeryLow),
   Some("http://rust-lang.org/".to_string()),
   application,
   notification_title,
   notification_description,
)?;

pub async fn add(&self) -> Result<(), AddError>

Send a notification to the Prowl API (and your devices).

Examples

Create a new notification and send it via add,

let application = "Mom".to_string();
let notification_title = "URGENT".to_string();
let notification_description = "We've been trying to reach you about your cars extended warrany".to_string();
let notification = prowl::Notification::new(
   vec!["MY-API-KEY".to_string()],
   None,
   None,
   application,
   notification_title,
   notification_description,
)?;

notification.add()?;

Trait Implementations

impl Debug for Notification

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

Formats the value using the given formatter.