Struct web_push::WebPushMessageBuilder

pub struct WebPushMessageBuilder<'a> { /* fields omitted */ }

The main class for creating a notification payload.

Methods

impl<'a> WebPushMessageBuilder<'a>

pub fn new(
    subscription_info: &'a SubscriptionInfo
) -> Result<WebPushMessageBuilder<'a>, WebPushError>

Creates a builder for generating the web push payload.

All parameters are from the subscription info given by browser when subscribing to push notifications.

pub fn set_ttl(&mut self, ttl: u32)

How long the server should keep the message if it cannot be delivered currently. If not set, the message is deleted immediately on failed delivery.

pub fn set_gcm_key(&mut self, gcm_key: &'a str)

For Google's push service, one must provide an API key from Firebase console.

pub fn set_vapid_signature(&mut self, vapid_signature: VapidSignature)

Add a VAPID signature to the request. To be generated with the VapidSignatureBuilder.

pub fn set_payload(&mut self, encoding: ContentEncoding, payload: &'a [u8])

If set, the client will get content in the notification. Has a maximum size of 3800 characters.

pub fn build(self) -> Result<WebPushMessage, WebPushError>

Builds and if set, encrypts the payload. Any errors will be Undefined, meaning something was wrong in the given public key or authentication.