BearyChat OpenAPI RTM Client
Compatible with Node.js, Webpack and Browserify.
Install
npm install bearychat-rtm-client --save
or with yarn
yarn add bearychat-rtm-client
Usage
API
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 |
Browser usage:
RTMClient uses native WebSocket in browser.
;;const RTMClientEvents = RTMClientRTMClientEvents; const client = { return bearychatrtmstarttoken: '<your hubot token>' ; }; client; client; client; client;
Node.js usage:
RTMClient need a W3C compatible WebSocket client implement. ws version 3.0.0+ is recommended.
const bearychat = ;const RTMClient = ;const RTMClientEvents = RTMClientRTMClientEvents;const WebSocket = ; const client = { return bearychatrtmstarttoken: '<your hubot token>' ; } WebSocket: WebSocket; client; client; client; client;
Client events
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 |
Client state
INITIAL
+
error |
+-------------+ |
v + v connect
RECONNECT+------->CONNECTING<---------+CLOSED
^ + ^
| | |
| server | |
| close/ v close +
+------------+CONNECTED+---------->CLOSING
error
RTM events
Examples
LICENSE
MIT