Reference documentation and code samples for the Cloud Firestore V1 Client class ListDocumentsResponse.
The response for Firestore.ListDocuments.
Generated from protobuf message google.firestore.v1.ListDocumentsResponse
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ documents |
array<Google\Cloud\Firestore\V1\Document>
The Documents found. |
↳ next_page_token |
string
A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. |
getDocuments
The Documents found.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDocuments
The Documents found.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Firestore\V1\Document>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextPageToken
A token to retrieve the next page of documents.
If this field is omitted, there are no subsequent pages.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNextPageToken
A token to retrieve the next page of documents.
If this field is omitted, there are no subsequent pages.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|