Struct PushMessage 

pub struct PushMessage {
    pub token: DeviceToken,
    pub title: String,
    pub body: String,
    pub data: BTreeMap<String, String>,
    pub channel_id: Option<String>,
}

One notification addressed to a single device token.

data travels alongside the visible notification and reaches the app when the user opens it. Keys are ordered so the serialized payload is stable, which keeps request bodies comparable in tests and logs.

Fields

token: DeviceToken

Provider-issued device token the notification is delivered to.

title: String

Notification title shown on the device.

body: String

Notification body shown on the device.

data: BTreeMap<String, String>

Optional key-value payload delivered with the notification.

channel_id: Option<String>

Provider channel the notification belongs to, when the platform has channels.

Android reads this to pick the notification channel. Leave it None for the provider default.

Implementations

impl PushMessage

pub fn new( token: DeviceToken, title: impl Into<String>, body: impl Into<String>, ) -> Self

Creates a message for a token with a title and body and no extra data.

pub fn with_data(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds one key-value pair to the notification payload.

pub fn with_channel_id(self, channel_id: impl Into<String>) -> Self

Sets the provider channel the notification belongs to.

Trait Implementations

impl Clone for PushMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PushMessage

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

Formats the value using the given formatter.

impl Eq for PushMessage

impl PartialEq for PushMessage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PushMessage