Rocket.Chat.RealTime.API.RxJS
v2.1.1
التجريد لاستخدام Rocket.Chat أساليب API في الوقت الفعلي مع 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 () | يبدأ الاتصالات بالخادم إلى واجهة برمجة تطبيقات الوقت الحقيقي. إرجاع يمكن ملاحظته مع استجابة الخادم |
| Keepalive () | إرجاع يمكن ملاحظته للاشتراك الذي يستجيب "Pong" لرسالة "Ping" التي أرسلها API في الوقت الفعلي. للحفاظ على الاتصال على قيد الحياة. |
| تسجيل الدخول (اسم المستخدم ، كلمة المرور) | إرجاع يمكن ملاحظته إلى النتيجة/الاستجابة من واجهة برمجة تطبيقات الوقت الحقيقي. |
| loginwithauthtoken (authtoken) | إرجاع يمكن ملاحظته إلى النتيجة/الاستجابة من واجهة برمجة تطبيقات الوقت الحقيقي. |
| loginwithoauth (credtoken ، credSecret) | إرجاع يمكن ملاحظته إلى النتيجة/الاستجابة من واجهة برمجة تطبيقات الوقت الحقيقي. |
| CallMethod (MethodName ، ... params) | إرجاع يمكن ملاحظته إلى نتيجة استدعاء الطريقة من الصاروخ. |
| SendMessage (jsonoBject) | يرسل كائن JSON إلى خادم API |
| onMessage (رسالة => console.log (رسالة)) | يشترك في الرسائل المرسلة من الخادم |
| onerror (خطأ => console.error (خطأ)) | يشترك في الأخطاء. |
| onCompletion (() => console.info ("كاملة")) | يشترك في الانتهاء في اتصال WebSocket |
| اشتراك (MessageHandler ، ErrorHandler ، CompleteHandler) | يشترك في جميع الرسائل والأخطاء والإكمال الثلاثة |
| getObservable () | إرجاع يمكن ملاحظته عن اتصال WebSocket إلى واجهة برمجة التطبيقات في الوقت الفعلي |
| قطع الاتصال() | افصل اتصال WebSocket بين العميل و API في الوقت الفعلي |
