Add disconnect method & Update documentation

master
Kawin 7 years ago
parent 3a6e1d6070
commit f3c05c1265

@ -3,7 +3,7 @@ Abstraction for Utilizing [Rocket.Chat](https://rocket.chat/)'s [Realtime API](h
## Installation
```
npm install --save rocket.chat.realtime.api.rxjs
npm install --save rocket.chat.realtime.api.rxjs
```
## Usage
@ -15,7 +15,7 @@ import { RealTimeAPI } from "rocket.chat.realtime.api.rxjs";
const realTimeAPI = new RealTimeAPI("wss://demo.rocket.chat/websocket");
// Provide, URL to the Rocket.Chat's Realtime API.
realTimeAPI.keepAlive();
realTimeAPI.keepAlive();
// Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive.
const auth = realTimeApi.login(USERNAME, PASSWORD);
@ -50,6 +50,7 @@ const auth = realTimeApi.login(USERNAME, PASSWORD);
| onCompletion(() => console.info("Complete")) | Subscribes to Completion on the Websocket Connection |
| subscribe(messageHandler, errorHandler, completionHandler) | Subscribes to All three i.e - messages, errors and completion |
| getObservable() | Returns observable of the WebSocket Connection to the RealTime API |
| disconnect() | Disconnect the WebSocket Connection between client and RealTime API |
| | |

@ -33,6 +33,13 @@ export class RealTimeAPI {
return this.webSocket.catch(err => Observable.of(err));
}
/**
* Disconnect the WebSocket Connection between client and RealTime API
*/
public disconnect() {
return this.webSocket.unsubscribe();
}
/**
* onMessage
*/

Loading…
Cancel
Save