Edit

SendOperations class

  • Reference
Package:
botframework-streaming

Send operations for streaming payloads.

Constructors

SendOperations(PayloadSender)

Initializes a new instance of the SendOperations class.

Methods

sendCancelStream(string)

The send operation used to send a PayloadTypes.cancelStream.
sendRequest(string, StreamingRequest)

The send operation used to send a StreamingRequest.
sendResponse(string, StreamingResponse)

The send operation used to send a PayloadTypes.response.

Constructor Details

SendOperations(PayloadSender)

Initializes a new instance of the SendOperations class.

new SendOperations(payloadSender: PayloadSender)

Parameters

payloadSender
PayloadSender

The PayloadSender that will send the disassembled data from all of this instance's send operations.

Method Details

sendCancelStream(string)

The send operation used to send a PayloadTypes.cancelStream.

function sendCancelStream(id: string): Promise<void>

Parameters

id

string

The ID to assign to the CancelDisassembler used by this operation.

Returns

Promise<void>

sendRequest(string, StreamingRequest)

The send operation used to send a StreamingRequest.

function sendRequest(id: string, request: StreamingRequest): Promise<void>

Parameters

id

string

The ID to assign to the RequestDisassembler used by this operation.

request
StreamingRequest

The request to send.

Returns

Promise<void>

sendResponse(string, StreamingResponse)

The send operation used to send a PayloadTypes.response.

function sendResponse(id: string, response: StreamingResponse): Promise<void>

Parameters

id

string

The ID to assign to the ResponseDisassembler used by this operation.

response
StreamingResponse

The response to send.

Returns

Promise<void>