PayloadReceiver class

パッケージ:

botframework-streaming

ストリーミング用のペイロード レシーバー。

プロパティ

disconnected
isConnected	現在の接続状態を取得する

メソッド

connect(ITransportReceiver)	トランスポート レシーバーに接続します。
disconnect(TransportDisconnectedEvent)	このレシーバーを強制的に切断します。
subscribe((header: IHeader) => SubscribableStream, (header: IHeader, stream: SubscribableStream, count: number) => void)	新しいデータが入ったときに通知を受け取るために、この受信者をサブスクライブできるようにします。

プロパティの詳細

disconnected

disconnected?: TransportDisconnectedEventHandler

プロパティ値

TransportDisconnectedEventHandler

isConnected

現在の接続状態を取得する

boolean isConnected

プロパティ値

boolean

トランスポート送信者に接続されている場合は true。

メソッドの詳細

connect(ITransportReceiver)

トランスポート レシーバーに接続します。

function connect(receiver: ITransportReceiver): Promise<void>

パラメーター

receiver

ITransportReceiver

ITransportReceiver オブジェクトから受信データをプルします。

戻り値

Promise<void>

受信側が完了したときに解決される Promise

disconnect(TransportDisconnectedEvent)

このレシーバーを強制的に切断します。

function disconnect(event?: TransportDisconnectedEvent)

パラメーター

event

TransportDisconnectedEvent

切断イベントのブロードキャスト時に含めるイベント引数。

subscribe((header: IHeader) => SubscribableStream, (header: IHeader, stream: SubscribableStream, count: number) => void)

新しいデータが入ったときに通知を受け取るために、この受信者をサブスクライブできるようにします。

function subscribe(getStream: (header: IHeader) => SubscribableStream, receiveAction: (header: IHeader, stream: SubscribableStream, count: number) => void)

パラメーター

getStream

(header: IHeader) => SubscribableStream

新しいストリームを受信したときのコールバック。

receiveAction

(header: IHeader, stream: SubscribableStream, count: number) => void

新しいメッセージを受信したときのコールバック。