Cloud Firestore V1 Client - Class ListDocumentsResponse (1.28.0)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDocuments

The Documents found.

Parameter
NameDescription
var array<Google\Cloud\Firestore\V1\Document>
Returns
TypeDescription
$this

getNextPageToken

A token to retrieve the next page of documents.

If this field is omitted, there are no subsequent pages.

Returns
TypeDescription
string

setNextPageToken

A token to retrieve the next page of documents.

If this field is omitted, there are no subsequent pages.

Parameter
NameDescription
var string
Returns
TypeDescription
$this