Merge pull request #26 from kawin-impekable/feature/disconnect_method

Add disconnect method & Update documentation
master
Viraj Trivedi 7 years ago committed by GitHub
commit 6018eeda31
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -6,7 +6,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
@ -18,7 +18,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);
@ -53,6 +53,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