Reference documentation and code samples for the Cloud Firestore V1 Client class Cursor.
A position in a query result set.
Generated from protobuf message google.firestore.v1.Cursor
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ values |
array<Google\Cloud\Firestore\V1\Value>
The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. |
↳ before |
bool
If the position is just before or just after the given values, relative to the sort order defined by the query. |
getValues
The values that represent a position, in the order they appear in the order by clause of a query.
Can contain fewer values than specified in the order by clause.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setValues
The values that represent a position, in the order they appear in the order by clause of a query.
Can contain fewer values than specified in the order by clause.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Firestore\V1\Value>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBefore
If the position is just before or just after the given values, relative to the sort order defined by the query.
| Returns | |
|---|---|
| Type | Description |
bool | |
setBefore
If the position is just before or just after the given values, relative to the sort order defined by the query.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |