Base
in package
Base Class Doc Comment
Tags
Table of Contents
- $api_end_point : string
- $http_status_code : mixed
- $invocation_context : InvocationContext
- $live_mode : string
- __toString() : string
- Gets the string presentation of the object
- getApiEndPoint() : string
- getHttpStatusCode() : mixed
- getInvocationContext() : InvocationContext
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- setInvocationContext() : mixed
- withContext() : mixed
- forClient() : mixed
- requestedBy() : mixed
- setAPIEndpoint() : mixed
- videChannel() : mixed
Properties
$api_end_point
protected
string
$api_end_point
$http_status_code
private
mixed
$http_status_code
$invocation_context
private
InvocationContext
$invocation_context
$live_mode
private
string
$live_mode
Methods
__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —getApiEndPoint()
public
getApiEndPoint() : string
Return values
string —getHttpStatusCode()
public
getHttpStatusCode() : mixed
Return values
mixed —getInvocationContext()
public
getInvocationContext() : InvocationContext
Return values
InvocationContext —jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
setInvocationContext()
public
setInvocationContext([InvocationContext $invocation_context = null ]) : mixed
Parameters
- $invocation_context : InvocationContext = null
Return values
mixed —withContext()
public
withContext(InvocationContext $request[, string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
- $request : InvocationContext
- $live_mode : string = null
- $apiEndPoint : string = null
Return values
mixed —forClient()
protected
forClient(mixed $client_key) : mixed
Parameters
- $client_key : mixed
Return values
mixed —requestedBy()
protected
requestedBy(mixed $requestor, mixed $requestor_type) : mixed
Parameters
- $requestor : mixed
- $requestor_type : mixed
Return values
mixed —setAPIEndpoint()
protected
setAPIEndpoint([string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
- $live_mode : string = null
- $apiEndPoint : string = null
Return values
mixed —videChannel()
protected
videChannel(mixed $channel) : mixed
Parameters
- $channel : mixed