StreamManager class

套件:

botframework-streaming

協調和管理數據流。

建構函式

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

初始化 StreamManager 類別的新實例。

方法

closeStream(string)	關閉指派給具有指定標識碼之 SubscribableStream 的 PayloadAssembler。
getPayloadAssembler(string)	如果存在，則擷取具有指定標識碼 PayloadAssembler，否則會建立新的實例並指派指定的標識符。
getPayloadStream(IHeader)	從 PayloadAssembler 擷取 SubscribableStream， 此管理員管理。
onReceive(IHeader, SubscribableStream, number)	用來設定接收數據時 Managed PayloadAssembler 的行為。

建構函式詳細資料

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

初始化 StreamManager 類別的新實例。

new StreamManager(onCancelStream: (contentStreamAssembler: PayloadAssembler) => void)

參數

onCancelStream

(contentStreamAssembler: PayloadAssembler) => void

取消 Managed 數據流時觸發的函式。

方法詳細資料

closeStream(string)

關閉指派給具有指定標識碼之 SubscribableStream 的 PayloadAssembler。

function closeStream(id: string)

參數

id

string

要關閉的 SubscribableStream 標識符。

getPayloadAssembler(string)

如果存在，則擷取具有指定標識碼 PayloadAssembler，否則會建立新的實例並指派指定的標識符。

function getPayloadAssembler(id: string): PayloadAssembler

參數

id

string

要擷取或建立之 PayloadAssembler 的標識符。

傳回

PayloadAssembler

具有指定標識碼的 PayloadAssembler。

getPayloadStream(IHeader)

從 PayloadAssembler 擷取 SubscribableStream， 此管理員管理。

function getPayloadStream(header: IHeader): SubscribableStream

參數

header

IHeader

要擷取之 SubscribableStream 的標頭。

傳回

SubscribableStream

具有指定標頭的 SubscribableStream。

onReceive(IHeader, SubscribableStream, number)

用來設定接收數據時 Managed PayloadAssembler 的行為。

function onReceive(header: IHeader, contentStream: SubscribableStream, contentLength: number)

參數

header

IHeader

數據流的標頭。

contentStream

SubscribableStream

要寫入傳入數據的 SubscribableStream。

contentLength

number

要寫入 contentStream 的數據量。