Rocket.Chat.RealTime.API.RxJS
v2.1.1
Abstraction pour l'utilisation des méthodes API de Rocket.Chat avec RXJS V6
npm install --save rocket.chat.realtime.api.rxjs
Pour la version RXJS V5 du package
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.
| Méthodes | Fonctionnalité |
|---|---|
| ConnectToServer () | Initie des connexions au serveur vers l'API en temps réel. Renvoie observable avec la réponse du serveur |
| keepalive () | Renvoie observable pour s'abonner qui répond "pong" au message "ping" envoyé par l'API en temps réel. Pour garder la connexion vivante. |
| Connexion (nom d'utilisateur, mot de passe) | Renvoie observable au résultat / réponse de l'API en temps réel. |
| LoginwithAuthToken (AuthToken) | Renvoie observable au résultat / réponse de l'API en temps réel. |
| LoginwithoAuth (CredToken, CredSecret) | Renvoie observable au résultat / réponse de l'API en temps réel. |
| callMethod (méthodyname, ... params) | Renvoie observable au résultat de l'appel de la méthode de Rocket.Chat API en temps réel |
| SendMessage (JSONObject) | Envoie l'objet JSON au serveur API |
| onMessage (message => console.log (message)) | Souscrit aux messages envoyés à partir du serveur |
| onError (error => console.error (erreur)) | Souscrit aux erreurs. |
| onCompletion (() => console.info ("complet")) | Souscrit à l'achèvement sur la connexion WebSocket |
| Abonnez-vous (MessageHandler, ErrorHandler, CompletionHandler) | Souscrit aux trois messages, des erreurs et de l'achèvement, c'est-à-dire |
| getObservable () | Renvoie observable de la connexion WebSocket à l'API en temps réel |
| déconnecter () | Débranchez la connexion WebSocket entre le client et l'API en temps réel |