BearyChat OpenAPI RTM Client

Compatible with Node.js, Webpack and Browserify.


- Install
- Usage
* API
+ RTMClient
* Browser usage:
* Node.js usage:
* Client events
* Client state
* RTM events
* Examples
- LICENSE

Install

``bash
npm install bearychat-rtm-client --save
`

or with yarn
`bash
yarn add bearychat-rtm-client
`

Usage

$3

#### RTMClient
constructor({ url, WebSocket })

| Param | Description |
| ---- | ---- |
| url | a websocket url or a function returns a promise that resolves to a websocket url |
| WebSocket | a W3C compatible WebSocket client implement |

$3

RTMClient uses native WebSocket in browser.

`javascript
import bearychat from 'bearychat';
import RTMClient from 'bearychat-rtm-client';
const RTMClientEvents = RTMClient.RTMClientEvents;

const client = new RTMClient({
url() {
return bearychat.rtm.start({token: ''})
.then(resp => resp.json())
.then(data => data.ws_host);
}
});

client.on(RTMClientEvents.ONLINE, function() {
console.log('RTM online');
});

client.on(RTMClientEvents.OFFLINE, function() {
console.log('RTM offline');
});

client.on(RTMClientEvents.EVENT, function(message) {
console.log('event message received: ', message);
});

client.send({
// your message body
});

`

$3

RTMClient need a W3C compatible WebSocket client implement. ws version 3.0.0+ is recommended.

`javascript
const bearychat = require('bearychat');
const RTMClient = require('bearychat-rtm-client');
const RTMClientEvents = RTMClient.RTMClientEvents;
const WebSocket = require('ws');

const client = new RTMClient({
url: function() {
return bearychat.rtm.start({token: ''})
.then(function (resp) {return resp.json()})
.then(function (data) {return data.ws_host});
},
WebSocket: WebSocket
});

client.on(RTMClientEvents.ONLINE, function() {
console.log('RTM online');
});

client.on(RTMClientEvents.OFFLINE, function() {
console.log('RTM offline');
});

client.on(RTMClientEvents.EVENT, function(message) {
console.log('event message received: ', message);
});

client.send({
// your message body
});

`

$3

| Event | Description |
| ----- | ----------- |
| RTMClientEvents.ONLINE| client connected |
| RTMClientEvents.OFFLINE | client disconnected |
| RTMClientEvents.CLOSE | client closed |
| RTMClientEvents.EVENT | receive event message from server |
| RTMClientEvents.ERROR | error occurred |

$3

`
INITIAL
+
error |
+-------------+ |
v + v connect
RECONNECT+------->CONNECTING<---------+CLOSED
^ + ^
| | |
| server | |
| close/ v close +
+------------+CONNECTED+---------->CLOSING
error
``

$3

RTM events

$3

BearyChat shell client

LICENSE

MIT