ZEROSPAM\Framework\SDK\Request\Api\IRequest

Interface IRequest

Request sent to the API server.

Synopsis

interface IRequest extends Arrayable {

• // methods
• public string routeUrl()
• public RequestType httpType()
• public IResponse processResponse()
• public IRequest addArgument()
• public IRequest removeArgument()
• public array getArguments()
• public UriInterface toUri()
• public IResponse getResponse()
• public void setResponse()
• public array requestOptions()
• public array getMergeableArguments()
• public int tries()
• public int incrementTries()
• public RequestType requestType()
• // Inherited methods from Arrayable
• public array toArray()
}


Hierarchy

Extends

• ZEROSPAM\Framework\SDK\Utils\Contracts\Arrayable

Methods

public

• addArgument() — Add a request argument.
• getArguments() — Get all the request arguments.
• getMergeableArguments() — Get the argument that can be merged with each other.
• getResponse() — Getter for response.
• httpType() — Type of request.
• incrementTries() — Increment the number of tries and returns it.
• processResponse() — Process the data that is in the response.
• removeArgument() — Remove a request argument.
• requestOptions() — Options for this request to be used by the client.
• requestType() — Request type to use for the request.
• routeUrl() — The url of the route.
• setResponse()
• toUri() — Return the URI of the request.
• tries() — Number of tries of the request.

Inherited from ZEROSPAM\Framework\SDK\Utils\Contracts\Arrayable

public

• toArray() — Return the object as Array.