Struct a2::WebNotificationBuilder

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

A builder to create a simple APNs notification payload.

Example

let mut builder = WebNotificationBuilder::new(WebPushAlert {title: "Hello", body: "World", action: "View"}, &["arg1"]);
builder.set_sound("prööt");
let payload = builder.build("device_id", Default::default())
   .to_json_string().unwrap();

Implementations

impl<'a> WebNotificationBuilder<'a>

pub fn new(
    alert: WebPushAlert<'a>,
    url_args: &'a [&'a str]
) -> WebNotificationBuilder<'a>

Creates a new builder with the minimum amount of content.

let mut builder = WebNotificationBuilder::new(WebPushAlert {title: "Hello", body: "World", action: "View"}, &["arg1"]);
let payload = builder.build("token", Default::default());

assert_eq!(
    "{\"aps\":{\"alert\":{\"action\":\"View\",\"body\":\"World\",\"title\":\"Hello\"},\"url-args\":[\"arg1\"]}}",
    &payload.to_json_string().unwrap()
);

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

File name of the custom sound to play when receiving the notification.

let mut builder = WebNotificationBuilder::new(WebPushAlert {title: "Hello", body: "World", action: "View"}, &["arg1"]);
builder.set_sound("meow");
let payload = builder.build("token", Default::default());

assert_eq!(
    "{\"aps\":{\"alert\":{\"action\":\"View\",\"body\":\"World\",\"title\":\"Hello\"},\"sound\":\"meow\",\"url-args\":[\"arg1\"]}}",
    &payload.to_json_string().unwrap()
);

Trait Implementations

impl<'a> NotificationBuilder<'a> for WebNotificationBuilder<'a>

fn build(
    self,
    device_token: &'a str,
    options: NotificationOptions<'a>
) -> Payload<'a>

Generates the request payload to be send with the Client.