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 的資料量。