Edit

PayloadDisassembler class

  • Reference
Package:
botframework-streaming

Base class streaming payload disassembling.

Constructors

PayloadDisassembler(PayloadSender, string)

Initializes a new instance of the PayloadDisassembler class.

Properties

payloadType

Methods

disassemble()

Begins the process of disassembling a payload and sending the resulting chunks to the PayloadSender to dispatch over the transport.
getStream()

Gets the stream this disassembler is operating on.

Constructor Details

PayloadDisassembler(PayloadSender, string)

Initializes a new instance of the PayloadDisassembler class.

new PayloadDisassembler(sender: PayloadSender, id: string)

Parameters

sender
PayloadSender

The PayloadSender used to send the disassembled payload chunks.

id

string

The ID of this disassembler.

Property Details

payloadType 

payloadType: PayloadTypes

Property Value

PayloadTypes

Method Details

disassemble()

Begins the process of disassembling a payload and sending the resulting chunks to the PayloadSender to dispatch over the transport.

function disassemble(): Promise<void>

Returns

Promise<void>

A completed Promise after the disassembled payload has been sent.

getStream()

Gets the stream this disassembler is operating on.

function getStream(): Promise<IStreamWrapper>

Returns

Promise<IStreamWrapper>

An IStreamWrapper with a Subscribable Stream.