Class shardimage\shardimagephpapi\api\Response

All Classes | Properties | Methods
Inheritanceshardimage\shardimagephpapi\api\Response » shardimage\shardimagephpapi\base\BaseObject
ImplementsJsonSerializable
Uses Traitsshardimage\shardimagephpapi\base\SimpleJsonSerializerTrait

API response object.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$callback callable Method to run after a successful non-polling request shardimage\shardimagephpapi\api\Response
$data mixed General response data shardimage\shardimagephpapi\api\Response
$error shardimage\shardimagephpapi\api\ResponseError|null Error object for the request shardimage\shardimagephpapi\api\Response
$id string Unique content ID shardimage\shardimagephpapi\api\Response
$jobId string|null Job ID for a polling request shardimage\shardimagephpapi\api\Response
$meta array Meta parameters in the response shardimage\shardimagephpapi\api\Response
$success boolean Is the request successful? shardimage\shardimagephpapi\api\Response

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Creates the object, populates the properties and calls the "init" method. shardimage\shardimagephpapi\base\BaseObject
__get() Returns the value of a non-defined property, it there is a getter method. shardimage\shardimagephpapi\base\BaseObject
__isset() Does the non-defined property with a getter exist and is it not NULL? shardimage\shardimagephpapi\base\BaseObject
__set() Sets the value of a non-defined property, if there is a setter method. shardimage\shardimagephpapi\base\BaseObject
__unset() Sets the value of a non-defined property to NULL, if there is a setter. shardimage\shardimagephpapi\base\BaseObject
jsonSerialize() Serializes the current object by cutting empty arrays and NULL properties. shardimage\shardimagephpapi\base\SimpleJsonSerializerTrait
toArray() Converts the object an array. shardimage\shardimagephpapi\base\BaseObject

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
ensureClass() Creates an object from the given parameters. shardimage\shardimagephpapi\base\BaseObject
init() Custom initialization. shardimage\shardimagephpapi\base\BaseObject

Property Details

$callback public property

Method to run after a successful non-polling request

public callable $callback = null
$data public property

General response data

public mixed $data = null
$error public property

Error object for the request

public shardimage\shardimagephpapi\api\ResponseError|null $error = null
$id public property

Unique content ID

public string $id = null
$jobId public property

Job ID for a polling request

public string|null $jobId = null
$meta public property

Meta parameters in the response

public array $meta = []
$success public property

Is the request successful?

public boolean $success = true