Struct MessageBuilder 

pub struct MessageBuilder { /* private fields */ }

Helps build a correct Pushover request.

Implementations

impl MessageBuilder

pub fn new(user_key: &str, application_token: &str, message: &str) -> Self

Creates a new MessageBuilder instance with the required minimal informations (User key, App token & Message)

pub fn modify_message(self, message: &str) -> MessageBuilder

Modifies the existing message.

pub fn set_title(self, title: &str) -> MessageBuilder

Sets a title to your message

pub fn add_title(self, title: &str) -> MessageBuilder

👎Deprecated since 0.3.12: Please use set_title instead.

Adds a title to your message

pub fn remove_title(self) -> MessageBuilder

Removes the title. The title will be defaulted to your application name.

pub fn set_url(self, url: &str, url_title: Option<&str>) -> MessageBuilder

Sets an url (and optionally, an url title) to send along with your message.

If set, the URL title will be shown, otherwise the URL will be shown.

pub fn add_url(self, url: &str, url_title: Option<&str>) -> MessageBuilder

👎Deprecated since 0.3.12: Please use set_url instead.

Adds an url (and optionally, an url title) to send along with your message.

If set, the URL title will be shown, otherwise the URL will be shown.

pub fn remove_url(self) -> MessageBuilder

Removes both the url and url title from your message

pub fn set_priority(self, priority: i8) -> MessageBuilder

Send as -2 to generate no notification/alert, -1 to always send as a quiet notification, 1 to display as high-priority and bypass the user’s quiet hours, or 2 to also require confirmation from the user.

pub fn remove_priority(self) -> MessageBuilder

Resets the priority to default (0, normal)

pub fn set_sound(self, sound: PushoverSound) -> MessageBuilder

Sets the sound to be used to notify the user.

See this list of available sounds: https://pushover.net/api#sounds

pub fn remove_sound(self) -> MessageBuilder

Removes the custom sound and reverts to the default sound.

pub fn set_timestamp(self, unix_timestamp: u64) -> MessageBuilder

Sets an Unix timestamp of your message’s date and time to display to the user, rather than the time your message is received by our API

pub fn remove_timestamp(self) -> MessageBuilder

Resets the custom unix timestamp

pub fn set_device(self, device_name: &str) -> MessageBuilder

Add a device name to send the notification to.

Overrides the current device if a new device name is set.

pub fn remove_device(self) -> MessageBuilder

Clears the device if set.

pub fn set_ttl(self, ttl_secs: u32) -> MessageBuilder

Set the TTL (Time to Live), in seconds

pub fn build(self) -> Message

Transforms the MessageBuilder into a useable Message

Trait Implementations

impl Debug for MessageBuilder

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

Formats the value using the given formatter.