PaginationOptions
in package
Pagination options for Soroban RPC requests.
Used by getEvents(), getLedgers(), and getTransactions() requests.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor.
- getCursor() : string|null
- getLimit() : int|null
- getRequestParams() : array<string|int, mixed>
- setCursor() : void
- setLimit() : void
Properties
$cursor
public
string|null
$cursor
= null
$limit
public
int|null
$limit
= null
Methods
__construct()
Constructor.
public
__construct([string|null $cursor = null ][, int|null $limit = null ]) : mixed
Parameters
- $cursor : string|null = null
-
A string ID that points to a specific location in a collection of responses and is pulled from the paging_token value of a record. When a cursor is provided Soroban-RPC will not include the element whose id matches the cursor in the response. Only elements which appear after the cursor are included.
- $limit : int|null = null
-
The maximum number of records returned. The limit for getEvents can range from 1 to 10000 - an upper limit that is hardcoded in Soroban-RPC for performance reasons. If this argument isn't designated, it defaults to 100.
getCursor()
public
getCursor() : string|null
Return values
string|null —A string ID that points to a specific location in a collection of responses and is pulled from the paging_token value of a record. When a cursor is provided Soroban-RPC will not include the element whose id matches the cursor in the response. Only elements which appear after the cursor are included.
getLimit()
public
getLimit() : int|null
Return values
int|null —The maximum number of records returned. The limit for getEvents can range from 1 to 10000 - an upper limit that is hardcoded in Soroban-RPC for performance reasons. If this argument isn't designated, it defaults to 100.
getRequestParams()
public
getRequestParams() : array<string|int, mixed>
Return values
array<string|int, mixed>setCursor()
public
setCursor(string|null $cursor) : void
Parameters
- $cursor : string|null
-
A string ID that points to a specific location in a collection of responses and is pulled from the paging_token value of a record. When a cursor is provided Soroban-RPC will not include the element whose id matches the cursor in the response. Only elements which appear after the cursor are included.
setLimit()
public
setLimit(int|null $limit) : void
Parameters
- $limit : int|null
-
The maximum number of records returned. The limit for getEvents can range from 1 to 10000 - an upper limit that is hardcoded in Soroban-RPC for performance reasons. If this argument isn't designated, it defaults to 100.