Compartilhar via

StreamManager class

  • Referência
Pacote:
botframework-streaming

Orquestra e gerencia fluxos.

Construtores

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

Inicializa uma nova instância da classe StreamManager.

Métodos

closeStream(string)

Fecha o PayloadAssembler atribuído à SubscribableStream com a ID fornecida.
getPayloadAssembler(string)

Recupera um PayloadAssembler com a ID fornecida se existir, caso contrário, uma nova instância será criada e atribuída a ID fornecida.
getPayloadStream(IHeader)

Recupera o SubscribableStream do PayloadAssembler que esse gerente gerencia.
onReceive(IHeader, SubscribableStream, number)

Usado para definir o comportamento do gerenciado PayloadAssembler quando os dados são recebidos.

Detalhes do construtor

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

Inicializa uma nova instância da classe StreamManager.

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

Parâmetros

onCancelStream

(contentStreamAssembler: PayloadAssembler) => void

Função a ser disparada se o fluxo gerenciado for cancelado.

Detalhes do método

closeStream(string)

Fecha o PayloadAssembler atribuído à SubscribableStream com a ID fornecida.

function closeStream(id: string)

Parâmetros

id

string

A ID do SubscribableStream do para fechar.

getPayloadAssembler(string)

Recupera um PayloadAssembler com a ID fornecida se existir, caso contrário, uma nova instância será criada e atribuída a ID fornecida.

function getPayloadAssembler(id: string): PayloadAssembler

Parâmetros

id

string

A ID do PayloadAssembler para recuperar ou criar.

Retornos

PayloadAssembler

O PayloadAssembler com a ID fornecida.

getPayloadStream(IHeader)

Recupera o SubscribableStream do PayloadAssembler que esse gerente gerencia.

function getPayloadStream(header: IHeader): SubscribableStream

Parâmetros

header
IHeader

O cabeçalho do SubscribableStream do a ser recuperado.

Retornos

SubscribableStream

O SubscribableStream com o cabeçalho especificado.

onReceive(IHeader, SubscribableStream, number)

Usado para definir o comportamento do gerenciado PayloadAssembler quando os dados são recebidos.

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

Parâmetros

header
IHeader

O cabeçalho do fluxo.

contentStream
SubscribableStream

O SubscribableStream para gravar dados de entrada.

contentLength

number

A quantidade de dados a serem gravados no contentStream.