1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
//! # A2 //! //! A2 is an asynchronous client to Apple push notification service. It //! provides a type-safe way to generate correct requests, mapping responses into //! corresponding types. The client supports both, certificate and token based //! authentication. //! //! To create a connection it is required to have either a PKCS12 database file //! including a valid certificate and private key with a password for unlocking //! it, or a private key in PKCS8 PEM format with the corresponding team and key //! ids. All of these should be available from Xcode or your Apple developer //! account. //! //! The library is meant to be high performace and typesafe, used together with //! the [Tokio framework](https://tokio.rs) in an asynchronous event loop. //! //! ## Payload //! //! Building the notification payload should be done with the corresponding builders: //! //! * [PlainNotificationBuilder](request/notification/struct.PlainNotificationBuilder.html) for text only messages. //! * [SilentNotificationBuilder](request/notification/struct.SilentNotificationBuilder.html) for silent notifications with custom data. //! * [LocalizedNotificationBuilder](request/notification/struct.LocalizedNotificationBuilder.html) for localized rich notifications. //! //! The payload generated by the builder [can hold a custom data //! section](request/payload/struct.Payload.html#method.add_custom_data), //! defined by a selected root key. Any data using `#[derive(Serialize)]` from //! [Serde](https://serde.rs/) works, allowing usage of type-safe structs or //! dynamic hashmaps to generate the custom data. //! //! ## Client //! //! The [asynchronous client](client/struct.Client.html), works either with //! [certificate](client/struct.Client.html#method.certificate) or //! [token](client/struct.Client.html#method.token) authentication. //! //! ## Example sending a plain notification using token authentication: //! //! ```no_run //! use a2::{PlainNotificationBuilder, NotificationBuilder, Client, Endpoint}; //! use std::fs::File; //! use futures::future::lazy; //! use futures::Future; //! //! fn main() { //! let mut builder = PlainNotificationBuilder::new("Hi there"); //! builder.set_badge(420); //! builder.set_category("cat1"); //! builder.set_sound("ping.flac"); //! //! let payload = builder.build("device-token-from-the-user", Default::default()); //! let mut file = File::open("/path/to/private_key.p8").unwrap(); //! //! let client = Client::token( //! &mut file, //! "KEY_ID", //! "TEAM_ID", //! Endpoint::Production).unwrap(); //! //! tokio::run(lazy(move || { //! client //! .send(payload) //! .map(|response| { //! println!("Sent: {:?}", response); //! }) //! .map_err(|error| { //! println!("Error: {:?}", error); //! }) //! })); //! } //! ``` //! //! ## Example sending a silent notification with custom data using certificate authentication: //! //! ```no_run //! #[macro_use] extern crate serde_derive; //! //! use a2::{Client, Endpoint, SilentNotificationBuilder, NotificationBuilder}; //! use std::fs::File; //! use futures::future::lazy; //! use futures::Future; //! //! #[derive(Serialize, Debug)] //! struct CorporateData { //! tracking_code: &'static str, //! is_paying_user: bool, //! } //! //! fn main() { //! let tracking_data = CorporateData { //! tracking_code: "999-212-UF-NSA", //! is_paying_user: false, //! }; //! //! let mut payload = SilentNotificationBuilder::new() //! .build("device-token-from-the-user", Default::default()); //! payload.add_custom_data("apns_gmbh", &tracking_data).unwrap(); //! //! let mut file = File::open("/path/to/cert_db.p12").unwrap(); //! //! let client = Client::certificate( //! &mut file, //! "Correct Horse Battery Stable", //! Endpoint::Production).unwrap(); //! //! let sending = client.send(payload); //! //! tokio::run(lazy(move || { //! sending //! .map(|response| { //! println!("Sent: {:?}", response); //! }) //! .map_err(|error| { //! println!("Error: {:?}", error); //! }) //! })); //! } //! ``` #[macro_use] extern crate serde_derive; #[allow(unused_imports)] #[macro_use] extern crate serde_json; #[allow(unused_imports)] #[macro_use] extern crate indoc; #[macro_use] extern crate log; pub mod request; pub mod error; pub mod response; pub mod client; mod signer; pub use crate::request::{ notification::{ NotificationBuilder, LocalizedNotificationBuilder, PlainNotificationBuilder, SilentNotificationBuilder, CollapseId, NotificationOptions, Priority, } }; pub use crate::response::{ Response, ErrorBody, ErrorReason, }; pub use crate::client::{ Endpoint, Client, FutureResponse, }; pub use crate::error::Error;