GetEventsRequest
in package
Used for getEvents()
Tags
Table of Contents
Properties
- $endLedger : int|null
- $filters : EventFilters|null
- $paginationOptions : PaginationOptions|null
- $startLedger : int|null
Methods
- __construct() : mixed
- Constructor.
- getEndLedger() : int|null
- getFilters() : EventFilters|null
- getPaginationOptions() : PaginationOptions|null
- getRequestParams() : array<string, mixed>
- Builds and returns the request parameters array for the RPC API call.
- getStartLedger() : int|null
- setEndLedger() : void
- setFilters() : void
- Sets the event filters for the request.
- setPaginationOptions() : void
- Sets the pagination options for the request.
- setStartLedger() : void
Properties
$endLedger
public
int|null
$endLedger
= null
$filters
public
EventFilters|null
$filters
= null
$paginationOptions
public
PaginationOptions|null
$paginationOptions
= null
$startLedger
public
int|null
$startLedger
= null
Methods
__construct()
Constructor.
public
__construct([int|null $startLedger = null ][, int|null $endLedger = null ][, EventFilters|null $filters = null ][, PaginationOptions|null $paginationOptions = null ]) : mixed
Parameters
- $startLedger : int|null = null
-
Ledger sequence number to fetch events after (inclusive). The getEvents method will return an error if startLedger is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node. If a cursor is included in the request, startLedger must be omitted.
- $endLedger : int|null = null
-
Ledger sequence number represents the end of search window (exclusive). If a cursor is included in the request, endLedger must be omitted.
- $filters : EventFilters|null = null
-
List of filters for the returned events. Events matching any of the filters are included. To match a filter, an event must match both a contractId and a topic. Maximum 5 filters are allowed per request.
- $paginationOptions : PaginationOptions|null = null
-
for pagination.
getEndLedger()
public
getEndLedger() : int|null
Return values
int|null —Ledger sequence number represents the end of search window (exclusive).
getFilters()
public
getFilters() : EventFilters|null
Return values
EventFilters|nullgetPaginationOptions()
public
getPaginationOptions() : PaginationOptions|null
Return values
PaginationOptions|null —for pagination.
getRequestParams()
Builds and returns the request parameters array for the RPC API call.
public
getRequestParams() : array<string, mixed>
Return values
array<string, mixed> —The request parameters formatted for Soroban RPC
getStartLedger()
public
getStartLedger() : int|null
Return values
int|null —Ledger sequence number to fetch events after (inclusive).
setEndLedger()
public
setEndLedger(int|null $endLedger) : void
Parameters
- $endLedger : int|null
-
Ledger sequence number represents the end of search window (exclusive). If a cursor is included in the request, endLedger must be omitted.
setFilters()
Sets the event filters for the request.
public
setFilters(EventFilters|null $filters) : void
Parameters
- $filters : EventFilters|null
-
List of filters for the returned events
setPaginationOptions()
Sets the pagination options for the request.
public
setPaginationOptions(PaginationOptions|null $paginationOptions) : void
Parameters
- $paginationOptions : PaginationOptions|null
-
for pagination.
setStartLedger()
public
setStartLedger(int|null $startLedger) : void
Parameters
- $startLedger : int|null
-
Ledger sequence number to fetch events after (inclusive). The getEvents method will return an error if startLedger is less than the oldest ledger stored in this node, or greater than the latest ledger seen by this node. If a cursor is included in the request, startLedger must be omitted.