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>

傳送完成時要執行的函式。