From d1edf9fdebfad0937a7b33b5f42a1377ac18823f Mon Sep 17 00:00:00 2001 From: Viraj Trivedi Date: Thu, 22 Jun 2017 18:50:55 +0530 Subject: [PATCH] Methods Described --- README.md | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 51e698a..dc5b460 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ Abstraction for Utilizing Rocket.Chat's Realtime API Methods with RxJS ## Installation -` npm install --save rocket.chat.realtime.api.rxjs ` +``` +npm install --save rocket.chat.realtime.api.rxjs +``` ## Usage @@ -17,22 +19,30 @@ const realTimeAPI = new RealTimeAPI("wss://demo.rocket.chat/websocket"); realTimeAPI.connectToServer(); // Connects to the RealTime API - realTimeAPI.keepAlive(); // Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive. ... ... -// Use any of the methods implmented in the package such as +// Use any of the methods implmented in the package. -login(username, password); -//Returns Observable to the Result of the called method, in this case login - -callMethod("method", ...params); -// Generic Method to Call any of the method from RealTime API. Returns Observable to the Result of the called method - -callMethod("rooms/get",[{ "$date": Date.now() / 1000 }]); -// Returns Observable to the Method called (rooms/get) with params [{ "$date": Date.now() / 1000 }]. +``` -``` \ No newline at end of file +## Methods + +| Methods | Functionality | +|------------------------------------------------------------ |----------------------------------------------------------------------------------------------- | +| connectToServer() | Connects to the RealTime API. | +| keepAlive() | Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive. | +| login(username, password) | Returns Observable to the Result/Response from the RealTime API. | +| loginWithAuthToken(authToken) | Returns Observable to the Result/Response from the RealTime API. | +| loginWithOAuth(credToken, credSecret) | Returns Observable to the Result/Response from the RealTime API. | +| callMethod(methodName, ...params) | Returns Observalble to the Result of Method Call from Rocket.Chat Realtime API | +| sendMessage(jsonObject) | Sends the JSON Object to the API Server | +| onMessage( message => console.log(message) ) | Subscribes to the Messages sent from the server | +| onError( error => console.error(error) ) | Subscribes to the Errors. | +| onCompletion( () => console.info("Complete") ) | Subscribes to Completion on the Websocket Connection | +| subscribe(messageHandler, errorHandler, completionHandler) | Subscribes to All 3, messages, errors and completion | +| getObservable() | Returns observable of the WebSocket Connection to the RealTime API | +| | | \ No newline at end of file