PayloadSender class

パッケージ:

botframework-streaming

ストリーミング ペイロードの送信者。

プロパティ

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

メソッド

connect(ITransportSender)	指定されたトランスポート送信者に接続します。
disconnect(TransportDisconnectedEvent)	このペイロード送信者を切断します。
sendPayload(IHeader, SubscribableStream, () => Promise<void>)	接続されているトランスポート送信者を介してペイロードを送信します。

プロパティの詳細

disconnected

disconnected?: TransportDisconnectedEventHandler

プロパティ値

TransportDisconnectedEventHandler

isConnected

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

boolean isConnected

プロパティ値

boolean

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

メソッドの詳細

connect(ITransportSender)

指定されたトランスポート送信者に接続します。

function connect(sender: ITransportSender)

パラメーター

sender

ITransportSender

このペイロード送信者を接続するトランスポート送信者。

disconnect(TransportDisconnectedEvent)

このペイロード送信者を切断します。

function disconnect(event?: TransportDisconnectedEvent)

パラメーター

event

TransportDisconnectedEvent

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

sendPayload(IHeader, SubscribableStream, () => Promise<void>)

接続されているトランスポート送信者を介してペイロードを送信します。

function sendPayload(header: IHeader, payload?: SubscribableStream, sentCallback?: () => Promise<void>)

パラメーター

header

IHeader

送信ペイロードにアタッチするヘッダー。

payload

SubscribableStream

送信するバッファー内のデータのストリーム。

sentCallback

() => Promise<void>

送信が完了したときに実行する関数。