pandapushjs
v1.0.0
Published
Client for Pandapush
Downloads
5
Readme
Pandapush Client
pandapush-client
is a wrapper around the Faye client to make some operations
with Pandapush simpler. Specifically, it allows you to subscribe to channels
while specifying a token at subscription time.
It also supports sending presence information for presence channels.
Getting Started
pandapush-client
is available as an npm module, or directly from a Pandapush
server.
Accessing Directly From Server
You can access the client from a server at https://{pandapush server}/client.js.
In your html:
<script src="https://pandapush-server/client.js"></script>
<script>
var client = new Pandapush.Client('https://pandapush-server/push');
...
</script>
Via npm
If you'd like to incorporate the client to your frontend build tool, you can also use the npm distributed version:
$ npm install pandapush-client --save-dev
var Pandapush = require('pandapush-client');
var client = new Pandapush.client('https://pandapush-server/push');
Usage
The Pandapush client is a thin wrapper over the Faye client, described here: http://faye.jcoglan.com/browser/subscribing.html
subscribe
Param | Type | | Description
-----------|--------|----------|------------
channel
| String | | The channel to subscribe to.
token
| String | optional | The token to use when subscribing. Must be specified if the channel is not public.
presence
| Object | optional | Presence information about the subscribing user. See below.
callback
| Function | | Function called on every new message.
presence
, if supplied, should be an object with at least an id
field. That
identifier uniquely identifies the connecting user, so would typically be a user id
or username. You can also include other keys in the object, and the entire object
is returned to all subscribers to this presence channel. Other fields could be
name
or avatar_url
. Keep the data minimal though - it is all persisted in the
Pandapush backend while the user is subscribed through at least one connection.
unsubscribe
See Faye documentation
addExtension
See Faye documentation