Documentation

ApiException extends Exception
in package

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Table of Contents

$isTimedOut  : mixed
$maskedAuthorizationData  : string
$maskedHttpRequest  : string
$responseBody  : mixed
The HTTP body of the server response either as Json or string.
$responseHeaders  : array<string|int, string>|null
The HTTP header of the server response.
$responseObject  : mixed
The deserialized response object
__construct()  : mixed
Constructor
getMaskedAuthorizationData()  : null|string
getMaskedHttpRequest()  : null|string
getResponseBody()  : mixed
Gets the HTTP body of the server response either as Json or string
getResponseHeaders()  : array<string|int, string>|null
Gets the HTTP response header
getResponseObject()  : mixed
Gets the deseralized response object (during deserialization)
isTimedOut()  : bool
setMaskedAuthorizationData()  : mixed
setMaskedHttpRequest()  : mixed
setResponseObject()  : void
Sets the deseralized response object (during deserialization)

Properties

$maskedAuthorizationData

protected string $maskedAuthorizationData

$responseBody

The HTTP body of the server response either as Json or string.

protected mixed $responseBody

$responseHeaders

The HTTP header of the server response.

protected array<string|int, string>|null $responseHeaders

$responseObject

The deserialized response object

protected mixed $responseObject

Methods

__construct()

Constructor

public __construct([string $message = "" ], int $code[, array<string|int, string>|null $responseHeaders = [] ][, mixed $responseBody = null ][, string $maskedHttpRequest = null ][, string $maskedAuthorizationData = null ][, mixed $isTimedOut = false ]) : mixed
Parameters
$message : string = ""

Error message

$code : int

HTTP status code

$responseHeaders : array<string|int, string>|null = []

HTTP response header

$responseBody : mixed = null

HTTP decoded body of the server response either as \stdClass or string

$maskedHttpRequest : string = null
$maskedAuthorizationData : string = null
$isTimedOut : mixed = false
Return values
mixed —

getMaskedAuthorizationData()

public getMaskedAuthorizationData() : null|string
Return values
null|string —

getMaskedHttpRequest()

public getMaskedHttpRequest() : null|string
Return values
null|string —

getResponseBody()

Gets the HTTP body of the server response either as Json or string

public getResponseBody() : mixed
Return values
mixed —

HTTP body of the server response either as \stdClass or string

getResponseHeaders()

Gets the HTTP response header

public getResponseHeaders() : array<string|int, string>|null
Return values
array<string|int, string>|null —

HTTP response header

getResponseObject()

Gets the deseralized response object (during deserialization)

public getResponseObject() : mixed
Return values
mixed —

the deserialized response object

isTimedOut()

public isTimedOut() : bool
Return values
bool —

setMaskedAuthorizationData()

public setMaskedAuthorizationData(null|string $maskedAuthorizationData) : mixed
Parameters
$maskedAuthorizationData : null|string
Return values
mixed —

setMaskedHttpRequest()

public setMaskedHttpRequest(null|string $maskedHttpRequest) : mixed
Parameters
$maskedHttpRequest : null|string
Return values
mixed —

setResponseObject()

Sets the deseralized response object (during deserialization)

public setResponseObject(mixed $obj) : void
Parameters
$obj : mixed

Deserialized response object

Return values
void —

Search results