Class HTTPRequestBody

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

Hierarchy

FrameworkObject
- HTTPRequestBody

Index

Constructors

Accessors

bodyStream fileName isFile

Constructors

constructor

new HTTPRequestBody(options?, isInternalConstructor?): HTTPRequestBody
Performs Alloc2.
Parameters
- Optionaloptions: {
      bodyContents: string;
      fileName?: string;
      isFile?: boolean;
  } | {
      fileName?: string;
      isFile?: boolean;
      stream: DataStream;
  }
  Options object for the function call.
- OptionalisInternalConstructor: boolean
Returns HTTPRequestBody
Overrides FrameworkObject.constructor

Accessors

bodyStream

get bodyStream(): DataStream
Stream of data to send with the request.

Returns DataStream
set bodyStream(value): 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): 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): void
Parameters
- value: boolean
Returns void