Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines a GET http request, to be used by HttpManager

Hierarchy

Index

Constructors

constructor

Properties

attempts

attempts: number = 1

ignoreGlobalPostParams

ignoreGlobalPostParams: boolean = false

If set to true, any global POST parameters that may be defined by the http manager which executes this request will be ignored. (exclusively for this request only)

parameters

parameters: {} | HashMapObject

A list of key / value pairs that will be used as parameters for this request

resultFormat

resultFormat: typeof STRING | typeof JSON = HTTPManagerBaseRequest.STRING

Specifies how the result of the request will be transformed. Possible values are:

  • HTTPManagerBaseRequest.STRING (See the constant docs for more info)
  • HTTPManagerBaseRequest.JSON (See the constant docs for more info)

timeout

timeout: number

Defines how much miliseconds will the http requests wait before failing with a timeout. If set to 0, no value will be specifically defined, so the httpmanager default will be used.

url

url: string

The url that will be called as part of this request

Static Readonly JSON

JSON: "JSON" = "JSON"

Defines the json format for the result format property. The result of request with this resultFormat will be a native type which will have been decoded from the request response body (expecting it to be a valid json string).

Static Readonly STRING

STRING: "STRING" = "STRING"

Defines the string format for the result format property. The result of request with this resultFormat will be returned as a raw string containing the exact request response body.

Methods

errorCallback

  • errorCallback(): void
  • A method to be executed if an error happens to the request execution. The callback function must have the following signature: (errorMsg:string, errorCode:number, response: string) => void

    errorMsg will contain the error text, errorCode will contain the numeric error http value and response will contain the main request response body

    Returns void

finallyCallback

  • finallyCallback(): void
  • A method to be executed always when the request finishes, even successfully or with an error. (This will be the very last method to be executed, allways after success or error callbacks).

    The callback function must have the following signature: () => void

    Returns void

successCallback

  • successCallback(): void
  • A method to be executed inmediately after the request execution finishes successfully (200 ok code). The callback function must have the following signature: (response) => void Where the response will be formatted according to how resultFormat is defined

    Returns void

Generated using TypeDoc