ListResourcesRequest extends Request
FinalYes
Sent from the client to request a list of resources the server has.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- fromArray() : static
- getId() : string|int
- getMeta() : array<string, mixed>|null
- getMethod() : string
- jsonSerialize() : RequestData
- withId() : static
- withMeta() : static
- fromParams() : static
- getParams() : array{cursor: string}|null
Properties
$cursor read-only
public
string|null
$cursor
= null
$id
protected
string|int
$id
$meta
protected
array<string, mixed>|null
$meta
= null
Methods
__construct()
public
__construct([string|null $cursor = null ]) : mixed
Parameters
- $cursor : string|null = null
-
An opaque token representing the current pagination position.
If provided, the server should return results starting after this cursor.
fromArray()
public
static fromArray(RequestData $data) : static
Parameters
- $data : RequestData
Return values
staticgetId()
public
getId() : string|int
Return values
string|intgetMeta()
public
getMeta() : array<string, mixed>|null
Return values
array<string, mixed>|nullgetMethod()
public
static getMethod() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : RequestData
Return values
RequestDatawithId()
public
withId(string|int $id) : static
Parameters
- $id : string|int
Return values
staticwithMeta()
public
withMeta(array<string, mixed>|null $meta) : static
Parameters
- $meta : array<string, mixed>|null
Return values
staticfromParams()
protected
static fromParams(array<string|int, mixed>|null $params) : static
Parameters
- $params : array<string|int, mixed>|null
Return values
staticgetParams()
protected
getParams() : array{cursor: string}|null