Rocket.Chat.RealTime.API.RxJS
v2.1.1
สิ่งที่เป็นนามธรรมสำหรับการใช้วิธี API แบบเรียลไทม์ของ Rocket.Chat กับ RXJS V6
npm install --save rocket.chat.realtime.api.rxjs
สำหรับแพ็คเกจเวอร์ชัน RXJS V5
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.
| วิธีการ | ฟังก์ชั่น |
|---|---|
| ConnectToserver () | เริ่มต้นการเชื่อมต่อกับเซิร์ฟเวอร์ไปยัง API เรียลไทม์ ส่งคืนที่สังเกตได้จากการตอบสนองของเซิร์ฟเวอร์ |
| Keepalive () | ส่งคืนที่สังเกตได้เพื่อสมัครสมาชิกซึ่งตอบสนอง "pong" ไปยังข้อความ "ping" ที่ส่งโดย API เรียลไทม์ เพื่อให้การเชื่อมต่อมีชีวิตอยู่ |
| เข้าสู่ระบบ (ชื่อผู้ใช้รหัสผ่าน) | ส่งคืนที่สังเกตได้จากผลลัพธ์/การตอบสนองจาก API เรียลไทม์ |
| LoginWithAuthToken (Authtoken) | ส่งคืนที่สังเกตได้จากผลลัพธ์/การตอบสนองจาก API เรียลไทม์ |
| LoginWithOauth (CredToken, CredSecret) | ส่งคืนที่สังเกตได้จากผลลัพธ์/การตอบสนองจาก API เรียลไทม์ |
| CallMethod (MethodName, ... Params) | ส่งคืนที่สังเกตได้ผลลัพธ์ของการโทรวิธีจาก rocket.chat เรียลไทม์ API |
| SendMessage (JSONObject) | ส่งวัตถุ JSON ไปยังเซิร์ฟเวอร์ API |
| onMessage (message => console.log (ข้อความ)) | สมัครรับข้อความที่ส่งจากเซิร์ฟเวอร์ |
| onerror (error => console.error (ข้อผิดพลาด)) | สมัครรับข้อมูลข้อผิดพลาด |
| oncompletion (() => console.info ("เสร็จสมบูรณ์"))) | สมัครสมาชิกเพื่อเสร็จสิ้นในการเชื่อมต่อ WebSocket |
| สมัครสมาชิก (MessageHandler, Errorhandler, PrectiveInhandler) | สมัครรับข้อมูลทั้งสามข้อความข้อผิดพลาดและความสมบูรณ์ |
| getobservable () | ส่งคืนการเชื่อมต่อ WebSocket ไปยัง API เรียลไทม์ API |
| ตัดการเชื่อมต่อ () | ถอดการเชื่อมต่อ WebSocket ระหว่างไคลเอนต์และ API เรียลไทม์ |
