Partager via

StreamManager class

  • Référence
Paquet:
botframework-streaming

Orchestre et gère les flux.

Constructeurs

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

Initialise une nouvelle instance de la classe StreamManager.

Méthodes

closeStream(string)

Ferme le PayloadAssembler affecté à l' SubscribableStream avec l’ID donné.
getPayloadAssembler(string)

Récupère un PayloadAssembler avec l’ID donné s’il en existe un, sinon une nouvelle instance est créée et affectée à l’ID donné.
getPayloadStream(IHeader)

Récupère le SubscribableStream à partir de la PayloadAssembler ce gestionnaire gère.
onReceive(IHeader, SubscribableStream, number)

Utilisé pour définir le comportement du PayloadAssembler managé lorsque les données sont reçues.

Détails du constructeur

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

Initialise une nouvelle instance de la classe StreamManager.

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

Paramètres

onCancelStream

(contentStreamAssembler: PayloadAssembler) => void

Fonction à déclencher si le flux managé est annulé.

Détails de la méthode

closeStream(string)

Ferme le PayloadAssembler affecté à l' SubscribableStream avec l’ID donné.

function closeStream(id: string)

Paramètres

id

string

ID de l'AbonnementStream à fermer.

getPayloadAssembler(string)

Récupère un PayloadAssembler avec l’ID donné s’il en existe un, sinon une nouvelle instance est créée et affectée à l’ID donné.

function getPayloadAssembler(id: string): PayloadAssembler

Paramètres

id

string

ID du PayloadAssembler à récupérer ou à créer.

Retours

PayloadAssembler

PayloadAssembler avec l’ID donné.

getPayloadStream(IHeader)

Récupère le SubscribableStream à partir de la PayloadAssembler ce gestionnaire gère.

function getPayloadStream(header: IHeader): SubscribableStream

Paramètres

header
IHeader

En-tête du AbonnementStream à récupérer.

Retours

SubscribableStream

Le AbonnementStream avec l’en-tête donné.

onReceive(IHeader, SubscribableStream, number)

Utilisé pour définir le comportement du PayloadAssembler managé lorsque les données sont reçues.

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

Paramètres

header
IHeader

En-tête du flux.

contentStream
SubscribableStream

Le AbonnementStream pour écrire des données entrantes.

contentLength

number

Quantité de données à écrire dans contentStream.