Request

Base class for all the requests

package

Default

Methods

Get body parameters

getBodyParameters() : array
abstract

Response

array

Values of body parameters (name of parameter => value of the parameter)

Returns true if HTTPS must be chosen over HTTP for this request

getEnsureHttps() : boolean

Response

boolean

true if HTTPS must be chosen

Get used HTTP method

getMethod() : static
abstract

Response

static

Used HTTP method

Get URI to the endpoint

getPath() : string
abstract

Response

string

URI to the endpoint

Get query parameters

getQueryParameters() : array
abstract

Response

array

Values of query parameters (name of parameter => value of the parameter)

Get request timeout

getTimeout() : integer

Response

integer

Request timeout in milliseconds

Sets if HTTPS must be chosen over HTTP for this request

setEnsureHttps( $ensure_https) 

Arguments

$ensure_https

Sets request timeout

setTimeout( $timeout) 

Arguments

$timeout

Properties

Timeout of the request in milliseconds

timeout : integer
var

Timeout of the request in milliseconds

Type(s)

integer

Sets if the HTTPS must be chosen over HTTP for this request

ensure_https : boolean
var

Sets if the HTTPS must be chosen over HTTP for this request

Type(s)

boolean