forked from pusher/pusher-http-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
35 lines (25 loc) · 1.13 KB
/
doc.go
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
/*
Package pusher is the Golang library for interacting with the Pusher HTTP API.
This package lets you trigger events to your client and query the state
of your Pusher channels. When used with a server, you can validate Pusher
webhooks and authenticate private- or presence-channels.
In order to use this library, you need to have a free account
on http://pusher.com. After registering, you will need the application
credentials for your app.
Getting Started
To create a new client, pass in your application credentials to a `pusher.Client` struct:
pusherClient := pusher.Client{
AppID: "your_app_id",
Key: "your_app_key",
Secret: "your_app_secret",
}
To start triggering events on a channel, we call `pusherClient.Trigger`:
data := map[string]string{"message": "hello world"}
// trigger an event on a channel, along with a data payload
pusherClient.Trigger("test_channel", "event", data)
Read on to see what more you can do with this library, such as
authenticating private- and presence-channels, validating Pusher webhooks,
and querying the HTTP API to get information about your channels.
Author: Jamie Patel, Pusher
*/
package pusher