Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines the base http request to be used with http manager

Hierarchy

Index

Constructors

constructor

  • Parameters

    • url: string
    • Default value timeout: number = 0

    Returns HTTPManagerBaseRequest

Properties

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

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: string) => void

    Returns void

Generated using TypeDoc