Skip to content

Commit 007dc98

Browse files
committed
Add docs on #channel_info and #channels
1 parent c9c70d0 commit 007dc98

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,16 @@ Pusher['a_channel'].trigger('an_event', {:some => 'data'})
125125

126126
This will continue to work, but has been replaced by `Pusher.trigger` which supports one or multiple channels.
127127

128+
### Using the Pusher REST API
129+
130+
This gem provides methods for accessing information from the [Pusher REST API](https://pusher.com/docs/rest_api). The documentation also shows an example of the responses from each of the API endpionts.
131+
132+
The following methods are provided by the gem. If you wish to query an API endpoint that doesn't have a specific method read on to learn how to make generic request to the REST API.
133+
134+
- `Pusher.channel_info('channel_name')` returns information about that channel.
135+
136+
- `Pusher.channels` returns information about all the channels in your Pusher application.
137+
128138
### Generic requests to the Pusher REST API
129139

130140
Aside from triggering events, the REST API also supports a number of operations for querying the state of the system. A reference of the available methods is available at <http://pusher.com/docs/rest_api>.

0 commit comments

Comments
 (0)