Rocket.Chat.RealTime.API.RxJS

Rocket.chat.realtime.api.rxjs

RXJS V6を使用してRocket.ChatのリアルタイムAPIメソッドを利用するための抽象化

インストール

 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」をリアルタイムAPIから送信した「Ping」メッセージに「Pong」を応答するサブスクライブに登録可能な戻り値を返します。接続を生かし続けます。
ログイン（ユーザー名、パスワード）	リアルタイムAPIからの結果/応答に観察可能なものを返します。
loginwithauthtoken（authtoken）	リアルタイムAPIからの結果/応答に観察可能なものを返します。
loginwithoauth（credtoken、credsecret）	リアルタイムAPIからの結果/応答に観察可能なものを返します。
callmethod（methodname、... params）	rocket.chatリアルタイムAPIからのメソッドコールの結果に観察可能な返品可能
sendmessage（jsonobject）	JSONオブジェクトをAPIサーバーに送信します
onmessage（message => console.log（message））	サーバーから送信されたメッセージを購読します
onerror（error => console.error（error））	エラーを購読します。
oncompletion（（）=> console.info（ "complete"））	WebSocket接続の完了を購読します
subscribe（messagehandler、errorhandler、completehandler）	3つすべてのIE -メッセージ、エラー、完了を購読しています
getobservable（）	リアルタイムAPIへのWebSocket接続の観察可能な返品
disconnect（）	クライアントとリアルタイムAPIの間のWebSocket接続を切断します

Rocket.ChatのリアルタイムAPIドキュメントをチェックアウトして、リアルタイムAPIの動作に関する詳細を確認してください。