Rocket.Chat.RealTime.API.RxJS
v2.1.1
Abstraktion zur Verwendung von Rocket.chats Echtzeit -API -Methoden mit RXJS V6
npm install --save rocket.chat.realtime.api.rxjs
Für die RXJS V5 -Version des Pakets
npm install --save [email protected]
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().subscribe();
// Responds "pong" to the "ping" message sent by the Realtime API. To keep the connection alive.
const auth = realTimeAPI.login(USERNAME, PASSWORD);
// Creating Observable
//Now subscribing the observable
auth.subscribe(
(data) => console.log(data),
(err) => console.log(err),
() => console.log('completed'));
...
...
// Use any of the methods implmented in the package.
| Methoden | Funktionalität |
|---|---|
| ConnectToServer () | Initiiert Verbindungen zum Server zur Echtzeit -API. Gibt mit der Antwort des Servers beobachtbar zurück |
| keepalive () | Rücksendungen beobachtbar, um abonnieren, was auf "Pong" auf die von der Echtzeit -API gesendete "ping" -Meldung reagiert. Um die Verbindung am Leben zu erhalten. |
| Login (Benutzername, Passwort) | Rücksendungen für das Ergebnis/die Reaktion der Echtzeit -API. |
| loginwithAuthtoken (authToken) | Rücksendungen für das Ergebnis/die Reaktion der Echtzeit -API. |
| LoginwithoAuth (CredoToken, CredSecret) | Rücksendungen für das Ergebnis/die Reaktion der Echtzeit -API. |
| CallMethod (MethodName, ... Params) | Rückgabe für das Ergebnis des Methodenaufrufs von Rocket.chat Echtzeit -API beobachtbar |
| sendMessage (JSONObject) | Sendet das JSON -Objekt an den API -Server |
| OnMessage (message => console.log (message)) | Abonniert die vom Server gesendeten Nachrichten |
| OnError (Fehler => console.Error (Fehler)) | Abonniert die Fehler. |
| Oncompletion (() => console.info ("komplett")) | Abonniert für die Fertigstellung der WebSocket -Verbindung |
| abonnieren (MessageHandler, ERRAGEHANDLER, CompletionHandler) | Abonniert alle drei IE - Nachrichten, Fehler und Fertigstellung |
| GetOboBservable () | Gibt zurück, wie die Websocket -Verbindung zur Echtzeit -API beobachtet werden kann |
| trennen() | Trennen Sie die WebSocket -Verbindung zwischen Client und Echtzeit -API |
