firebase::firestore::AggregateQuerySnapshot

#include <aggregate_query_snapshot.h>

The results of executing an AggregateQuery.

Summary

Note: Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Constructors and Destructors
AggregateQuerySnapshot() Creates an invalid AggregateQuerySnapshot that has to be reassigned before it can be used.
AggregateQuerySnapshot(const AggregateQuerySnapshot & other) Copy constructor.
AggregateQuerySnapshot(AggregateQuerySnapshot && other) Move constructor.
~AggregateQuerySnapshot()

Public functions
count() const	virtual int64_t Returns the number of documents in the result set of the underlying query.
is_valid() const	bool Returns true if this AggregateQuerySnapshot is valid, false if it is not valid.
operator=(const AggregateQuerySnapshot & other)	AggregateQuerySnapshot & Copy assignment operator.
operator=(AggregateQuerySnapshot && other)	AggregateQuerySnapshot & Move assignment operator.
query() const	virtual AggregateQuery Returns the query that was executed to produce this result.

Public functions

AggregateQuerySnapshot

 AggregateQuerySnapshot()

Creates an invalid AggregateQuerySnapshot that has to be reassigned before it can be used.

Calling any member function on an invalid AggregateQuerySnapshot will be a no-op. If the function returns a value, it will return a zero, empty, or invalid value, depending on the type of the value.

AggregateQuerySnapshot

 AggregateQuerySnapshot(
  const AggregateQuerySnapshot & other
)

Copy constructor.

AggregateQuerySnapshot is immutable and can be efficiently copied (no deep copy is performed).

Details
Parameters	other AggregateQuerySnapshot to copy from.

AggregateQuerySnapshot

 AggregateQuerySnapshot(
  AggregateQuerySnapshot && other
)

Move constructor.

Moving is more efficient than copying for a AggregateQuerySnapshot. After being moved from, a AggregateQuerySnapshot is equivalent to its default-constructed state.

Details
Parameters	other AggregateQuerySnapshot to move data from.

count

virtual int64_t count() const 

Returns the number of documents in the result set of the underlying query.

Details
Returns	The number of documents in the result set of the underlying query.

is_valid

bool is_valid() const 

Returns true if this AggregateQuerySnapshot is valid, false if it is not valid.

An invalid AggregateQuerySnapshot could be the result of:

• Creating a AggregateQuerySnapshot using the default constructor.
• Moving from the AggregateQuerySnapshot.
• Deleting your Firestore instance, which will invalidate all the AggregateQuerySnapshot instances associated with it.

Details
Returns	true if this AggregateQuerySnapshot is valid, false if this AggregateQuerySnapshot is invalid.

operator=

AggregateQuerySnapshot & operator=(
  const AggregateQuerySnapshot & other
)

Copy assignment operator.

AggregateQuerySnapshot is immutable and can be efficiently copied (no deep copy is performed).

Details
Parameters	other AggregateQuerySnapshot to copy from.
Returns	Reference to the destination AggregateQuerySnapshot.

operator=

AggregateQuerySnapshot & operator=(
  AggregateQuerySnapshot && other
)

Move assignment operator.

Moving is more efficient than copying for a AggregateQuerySnapshot. After being moved from, a AggregateQuerySnapshot is equivalent to its default-constructed state.

Details
Parameters	other AggregateQuerySnapshot to move data from.
Returns	Reference to the destination AggregateQuerySnapshot.

query

virtual AggregateQuery query() const 

Returns the query that was executed to produce this result.

Details
Returns	The AggregateQuery instance.

~AggregateQuerySnapshot

virtual  ~AggregateQuerySnapshot()