Struct Msg

pub struct Msg { /* private fields */ }

Push Notification Message structure.

This struct represents a push notification message that can be sent to devices. It contains various fields to customize the notification’s behavior and appearance.

Example

use bark::msg::Msg;

// new a simple message with title and body
let msg = Msg::new("title", "body");

// new a message with title = Notification and body
let mut msg = Msg::with_body("body");

// set some fields
msg.set_level("active");
msg.set_badge(1);
// and so on

Implementations

impl Msg

pub fn new(title: &str, body: &str) -> Self

Creates a new Msg instance with a title and body.

Arguments

• title: The title of the notification.
• body: The content/body of the notification.

Returns

A new Msg instance.

pub fn with_body(body: &str) -> Self

Creates a new Msg instance with only a body.

Arguments

• body: The content/body of the notification.

Returns

A new Msg instance with the title set to “Notification”.

pub fn set_level(&mut self, level: &str) -> &mut Self

Sets the interruption level of the notification.

Arguments

• level: The interruption level (active, timeSensitive, or passive).

Returns

A mutable reference to self for method chaining.

pub fn set_badge(&mut self, badge: u64) -> &mut Self

Sets the badge number.

Arguments

• badge: The badge number to display on the app icon.

Returns

A mutable reference to self for method chaining.

pub fn set_auto_copy(&mut self, auto_copy: u8) -> &mut Self

Sets whether to automatically copy the notification content.

Arguments

• auto_copy: 0 to disable, other values to enable.

Returns

A mutable reference to self for method chaining.

pub fn set_copy(&mut self, copy: &str) -> &mut Self

Sets specific content to copy when the notification is copied.

Arguments

• copy: The content to copy.

Returns

A mutable reference to self for method chaining.

pub fn set_sound(&mut self, sound: &str) -> &mut Self

Sets the sound file to play with the notification.

Arguments

• sound: The sound file name.

Returns

A mutable reference to self for method chaining.

pub fn set_icon(&mut self, icon: &str) -> &mut Self

Sets a custom icon URL for the notification.

Arguments

• icon: The icon URL.

Returns

A mutable reference to self for method chaining.

pub fn set_group(&mut self, group: &str) -> &mut Self

Sets the group identifier for notifications.

Arguments

• group: The group identifier.

Returns

A mutable reference to self for method chaining.

pub fn set_is_archive(&mut self, is_archive: u8) -> &mut Self

Sets whether to archive the notification.

Arguments

• is_archive: 1 to save, other values to not save.

Returns

A mutable reference to self for method chaining.

pub fn set_url(&mut self, url: &str) -> &mut Self

Sets the URL to open when the notification is clicked.

Arguments

• url: The URL.

Returns

A mutable reference to self for method chaining.

pub fn set_iv(&mut self, iv: &str) -> &mut Self

Sets the initialization vector for encryption.

Arguments

• iv: The initialization vector.

Returns

A mutable reference to self for method chaining.

pub fn gen_iv(&mut self) -> &mut Self

Generates a random initialization vector.

Returns

A mutable reference to self for method chaining.

pub fn set_enc_type(&mut self, enc_type: &EncryptType) -> &mut Self

Sets the encryption type and updates the cipher.

Arguments

• enc_type: The encryption type EncryptType.

Panics

Panics if the encryption type already set.

Returns

A mutable reference to self for method chaining.

pub fn set_mode(&mut self, mode: &EncryptMode) -> &mut Self

Sets the encryption mode and updates the cipher.

Arguments

• mode: The encryption mode EncryptMode.

Panics

Panics if the encryption mode already set.

Returns

A mutable reference to self for method chaining.

pub fn set_key(&mut self, key: &str) -> &mut Self

Sets the encryption key.

Arguments

• key: The encryption key.

Returns

A mutable reference to self for method chaining.

pub fn serialize(&self) -> String

Serializes the message into a JSON string, encrypting the message if necessary.

Returns

A String containing the serialized message.