Class AsyncHTTPRequest

The HTTPRequest class implements an asynchronous HTTP request that is capable of doing both Get and Post.

Index

Constructors

Accessors

cacheDurationInSeconds errorMessage isCached isCompleted isFailed isInProgress progressReport requestBodies requestBody response statusCode

Methods

cancel execute getHeaderValue removeHeader setHeader

Constructors

constructor

new AsyncHTTPRequest(
    url: URL,
    verb?: EnumValue<HTTPRequestVerb>,
    isInternalConstructor?: boolean,
): AsyncHTTPRequest
Creates the web request for the specified url. The request is in an idle state until the execute API is invoked.
Parameters
- url: URL
- Optionalverb: EnumValue<HTTPRequestVerb>
- OptionalisInternalConstructor: boolean
Returns AsyncHTTPRequest

Overrides FrameworkObject.constructor

Accessors

cacheDurationInSeconds

get cacheDurationInSeconds(): number

Gets the cache duration in seconds. Must be set before calling execute.

Returns number

Note
A request caching is only available if this value is set the first time the URL is requested. Future requests will only used the cached request, if the value is set. The response will only be cached for the duration that was specified when the cache entry was created.
set cacheDurationInSeconds(value: number): void
Parameters
- value: number
Returns void

errorMessage

get errorMessage(): string

Gets the error message.

Returns string

isCached

get isCached(): boolean

Determines if the request was loaded for the cache.

Returns boolean

isCompleted

get isCompleted(): boolean

Determines if the response data is available.

Returns boolean

isFailed

get isFailed(): boolean

Determines if the request failed. The failure data is available via errorMessage and statusCode.

Returns boolean

isInProgress

get isInProgress(): boolean

Determines if the request is being executed.

Returns boolean

progressReport

get progressReport(): HTTPRequestProgressReport

Gets or updates an object that can be used for tracking progress of the HTTP request..

Returns HTTPRequestProgressReport

requestBodies

get requestBodies(): Iterable<HTTPRequestBody>

Gets the request body.

Returns Iterable<HTTPRequestBody>
set requestBodies(
value: Iterable<HTTPRequestBody> | readonly HTTPRequestBody[],
): void
Parameters
- value: Iterable<HTTPRequestBody> | readonly HTTPRequestBody[]
Returns void

requestBody

get requestBody(): HTTPRequestBody

Gets the request body.

Returns HTTPRequestBody
set requestBody(value: HTTPRequestBody): void
Parameters
- value: HTTPRequestBody
Returns void

response

get response(): DataStream

Returns the buffer holding the request response. Only valid after the request has completed successfully.

Returns DataStream

statusCode

get statusCode(): number

Gets the status code.

Returns number

Methods

cancel

cancel(): boolean

Cancels the web request if it's currently in progress.

Returns boolean
true if the web request was cancelled.

execute

execute(): AsyncOp<AsyncHTTPRequest>

Executes the web request and returns an async operation. If the request failed, the request contains an error message.

Returns AsyncOp<AsyncHTTPRequest>

getHeaderValue

getHeaderValue(name: string): string
Gets the header with the name.
Parameters
- name: string
Returns string

removeHeader

removeHeader(name: string): void
Removes the header with
Parameters
- name: string
Returns void

setHeader

setHeader(name: string, value: string): void
Sets the header with name to the specified value.
Parameters
- name: string
- value: string
Returns void