Edit

Share via

StreamingRequest class

  • Reference
Package:
botframework-streaming

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

Properties

path

Request path; null on responses.
streams

List of associated streams.
verb

Request verb, null on responses.

Methods

addStream(HttpContent)

Adds a new stream attachment to this streaming request.
create(string, string, HttpContent)

Creates a streaming request with the passed in method, path, and body.
setBody(any)

Sets the contents of the body of this streamingRequest.

Property Details

path

Request path; null on responses.

path: string

Property Value

string

streams

List of associated streams.

streams: HttpContentStream[]

Property Value

HttpContentStream[]

verb

Request verb, null on responses.

verb: string

Property Value

string

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(string, string, HttpContent)

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

static function create(method: string, path?: string, body?: HttpContent): StreamingRequest

Parameters

method

string

The HTTP verb to use for this request.

path

string

Optional path where the resource can be found on the remote server.

body
HttpContent

Optional body to send to the remote server.

Returns

StreamingRequest

On success returns a streaming request with appropriate status code and body.

setBody(any)

Sets the contents of the body of this streamingRequest.

function setBody(body: any)

Parameters

body

any

The JSON text to write to the body of the streamingRequest.