[−][src]Struct pusher::Pusher

pub struct Pusher<C> {
    pub app_id: String,
    pub key: String,
    pub secret: String,
    pub host: String,
    pub secure: bool,
    pub http_client: Client<C>,
}

A client to interact with Pusher's HTTP API to trigger, query application state, authenticate private- or presence-channels, and validate webhooks.

Fields

app_id: String

Your app_id from http://app.pusher.com

key: String

Your key from http://app.pusher.com

secret: String

Your secret from http://app.pusher.com

host: String

The host[:port] you wish to connect to. Defaults to api.pusherapp.com

secure: bool

If true, requests are made over HTTPS.

http_client: Client<C>

The underlying Hyper HTTP client.

Implementations

`impl<C: Connect + Clone + Send + Sync + 'static> Pusher<C>`[src]

`pub async fn trigger<'_, '_, '_, S: Serialize>( &'_ self, channel: &'_ str, event: &'_ str, payload: S ) -> Result<TriggeredEvents, String>`[src]

This method allows you to trigger Pusher events. You can test this out by going on your debug console at http://app.pusher.com.

It is possible to trigger an event on one or more channels. Channel names can contain only characters which are alphanumeric, _ or -` and have to be at most 200 characters long. Event name can be at most 200 characters long too, and a payload is limited to 10kb.

This method is for triggering on only one channel, and does not allow socket_ids to be passed in for excluding recipients. If you wish to trigger on multiple channels, use trigger_multi. If you wish to exclude recipients by their socket_id, use trigger_exclusive. For doing both, use trigger_multi_exclusive.

Example:

let mut hash_map = HashMap::new();
hash_map.insert("message", "hello world");
pusher.trigger("test_channel", "my_event", &hash_map);

If you call this with http://app.pusher.com open, you should receive an alert saying, 'hello world'.

This method returns a Result. If successful, the Ok value will be a TriggeredEvents instance, which, if you are connected to certain clusters, holds the event_ids of published events. If an error has occured, the Error value will contain a String regarding what went wrong.

`pub async fn trigger_exclusive<'_, '_, '_, '_, S: Serialize>( &'_ self, channel: &'_ str, event: &'_ str, payload: S, socket_id: &'_ str ) -> Result<TriggeredEvents, String>`[src]

This method allow you to exclude a recipient whose connection has that socket_id from receiving the event. You can read more here: http://pusher.com/docs/duplicates.

Example:

pusher.trigger_exclusive("test_channel", "my_event", "hello", "123.12");

`pub async fn trigger_multi<'_, '_, '_, '_, S: Serialize>( &'_ self, channels: &'_ [&'_ str], event: &'_ str, payload: S ) -> Result<TriggeredEvents, String>`[src]

This method allow you to trigger an event on multiple channels, with a maximum of 10.

Example:

let channels = vec!["test_channel", "test_channel2"];
pusher.trigger_multi(&channels, "my_event", "hello");

`pub async fn trigger_multi_exclusive<'_, '_, '_, '_, '_, S: Serialize>( &'_ self, channels: &'_ [&'_ str], event: &'_ str, payload: S, socket_id: &'_ str ) -> Result<TriggeredEvents, String>`[src]

This method allow you to trigger an event on multiple channels and exclude a recipient with a given socket_id.

Example:

let channels = vec!["test_channel", "test_channel2"];
pusher.trigger_multi_exclusive(&channels, "my_event", "hello", "123.12");

`pub async fn channels<'_>(&'_ self) -> Result<ChannelList, String>`[src]

One can use this method to get a list of all the channels in an application from the HTTP API.

Without any supplied options, all fields for each Channel will be None. If you wish to specify options for your query, see the channels_with_options method.