StreamingResponse class

Package:

botframework-streaming

The basic response type sent over Bot Framework Protocol 3 with Streaming Extensions transports, equivalent to HTTP response messages.

Properties

statusCode
streams

Methods

addStream(HttpContent)	Adds a new stream attachment to this streaming request.
create(number, HttpContent)	Creates a streaming response with the passed in method, path, and body.
setBody(any)	Sets the contents of the body of this streaming response.

Property Details

statusCode

statusCode: number

Property Value

number

streams

streams: HttpContentStream[]

Property Value

HttpContentStream[]

Method Details

addStream(HttpContent)

Adds a new stream attachment to this streaming request.

function addStream(content: HttpContent)

Parameters

content

HttpContent

The Http content to include in the new stream attachment.

create(number, HttpContent)

Creates a streaming response with the passed in method, path, and body.

static function create(statusCode: number, body?: HttpContent): StreamingResponse

Parameters

statusCode

number

The HTTP verb to use for this request.

body

HttpContent

Optional body containing additional information.

Returns

StreamingResponse

A streaming response with the appropriate statuscode and passed in body.

setBody(any)

Sets the contents of the body of this streaming response.

function setBody(body: any)

Parameters

body

any

The JSON text to write to the body of the streaming response.