Class HTTPRequestBody

Represents a HTTP request body that will be submitted to the remote server when the request is executed.

Index

Constructors

Accessors

bodyStream fileName isFile

Constructors

constructor

new HTTPRequestBody(): HTTPRequestBody

Returns HTTPRequestBody

Overrides FrameworkObject.constructor
new HTTPRequestBody(
    bodyContents: string,
    isFile?: boolean,
    fileName?: string,
    isInternalConstructor?: boolean,
): HTTPRequestBody
Parameters
- bodyContents: string
- OptionalisFile: boolean
- OptionalfileName: string
- OptionalisInternalConstructor: boolean
Returns HTTPRequestBody

Overrides FrameworkObject.constructor
new HTTPRequestBody(
    stream: DataStream,
    isFile?: boolean,
    fileName?: string,
): HTTPRequestBody
Parameters
- stream: DataStream
- OptionalisFile: boolean
- OptionalfileName: string
Returns HTTPRequestBody

Overrides FrameworkObject.constructor

Accessors

bodyStream

get bodyStream(): DataStream

Stream of data to send with the request.

Returns DataStream
set bodyStream(value: DataStream): void
Parameters
- value: DataStream
Returns void

fileName

get fileName(): string

If part of a multipart request, specifies the name of the file.

Returns string
set fileName(value: string): void
Parameters
- value: string
Returns void

isFile

get isFile(): boolean

True if the stream that represents a file to be saved.

Returns boolean
set isFile(value: boolean): void
Parameters
- value: boolean
Returns void