firebase::firestore::DocumentSnapshot

#include <document_snapshot.h>

ADocumentSnapshot contains data read from a document in yourFirestore database.

Summary

The data can be extracted with theGetData() method, or by usingGet() to access a specific field. For aDocumentSnapshot that points to a non-existing document, any data access will cause a failed assertion. You can use theexists() method to explicitly verify a document's existence.

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

DocumentSnapshot()
Creates an invalidDocumentSnapshot that has to be reassigned before it can be used.
DocumentSnapshot(constDocumentSnapshot & other)
Copy constructor.
DocumentSnapshot(DocumentSnapshot && other)
Move constructor.
~DocumentSnapshot()

Public types

ServerTimestampBehavior{
  kNone = 0,
  kEstimate,
  kPrevious,
  kDefault = 0
}		enum
Controls the return value for server timestamps that have not yet been set to their final value.

Friend classes

operator<<
friend std::ostream &
Outputs the string representation of thisDocumentSnapshot to the given stream.

Public functions

Get(const char *field,ServerTimestampBehavior stb) const
virtualFieldValue
Retrieves a specific field from the document.
Get(const std::string & field,ServerTimestampBehavior stb) const
virtualFieldValue
Retrieves a specific field from the document.
Get(constFieldPath & field,ServerTimestampBehavior stb) const
virtualFieldValue
Retrieves a specific field from the document.
GetData(ServerTimestampBehavior stb) const
Retrieves all fields in the document as a map of FieldValues.
ToString() const
std::string
Returns a string representation of thisDocumentSnapshot for logging/debugging purposes.
exists() const
virtual bool
Explicitly verify a document's existence.
id() const
virtual const std::string &
Returns the string ID of the document for which thisDocumentSnapshot contains data.
is_valid() const
bool
Returns true if thisDocumentSnapshot is valid, false if it is not valid.
metadata() const
Returns the metadata about this snapshot concerning its source and if it has local modifications.
operator=(constDocumentSnapshot & other)
Copy assignment operator.
operator=(DocumentSnapshot && other)
Move assignment operator.
reference() const
Returns the document location for which thisDocumentSnapshot contains data.

Public types

ServerTimestampBehavior

ServerTimestampBehavior

Controls the return value for server timestamps that have not yet been set to their final value.

Properties
kDefault

The default behavior, which is equivalent to specifying kNone.

kEstimate

Return local estimates for server timestamps that have not yet been set to their final value.

This estimate will likely differ from the final value and may cause these pending values to change once the server result becomes available.

kNone

Return Null for server timestamps that have not yet been set to their final value.

kPrevious

Return the previous value for server timestamps that have not yet been set to their final value.

Friend classes

operator<<

friendstd::ostream&operator<<(std::ostream&out,constDocumentSnapshot&document)

Outputs the string representation of thisDocumentSnapshot to the given stream.

See also:ToString() for comments on the representation format.

Public functions

DocumentSnapshot

DocumentSnapshot()

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

Calling any member function on an invalidDocumentSnapshot 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.

DocumentSnapshot

DocumentSnapshot(constDocumentSnapshot&other)

Copy constructor.

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

Details
Parameters
other
DocumentSnapshot to copy from.

DocumentSnapshot

DocumentSnapshot(DocumentSnapshot&&other)

Move constructor.

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

Details
Parameters
other
DocumentSnapshot to move data from.

Get

virtualFieldValueGet(constchar*field,ServerTimestampBehaviorstb)const

Retrieves a specific field from the document.

Details
Parameters
field
String ID of the field to retrieve. The pointer only needs to be valid during this call.
stb
Configures how server timestamps that have not yet been set to their final value are returned from the snapshot (optional).
Returns
The value contained in the field. If the field does not exist in the document, then aFieldValue instance withis_valid() == false will be returned.

Get

virtualFieldValueGet(conststd::string&field,ServerTimestampBehaviorstb)const

Retrieves a specific field from the document.

Details
Parameters
field
String ID of the field to retrieve.
stb
Configures how server timestamps that have not yet been set to their final value are returned from the snapshot (optional).
Returns
The value contained in the field. If the field does not exist in the document, then aFieldValue instance withis_valid() == false will be returned.

Get

virtualFieldValueGet(constFieldPath&field,ServerTimestampBehaviorstb)const

Retrieves a specific field from the document.

Details
Parameters
field
Path of the field to retrieve.
stb
Configures how server timestamps that have not yet been set to their final value are returned from the snapshot (optional).
Returns
The value contained in the field. If the field does not exist in the document, then aFieldValue instance withis_valid() == false will be returned.

GetData

virtualMapFieldValueGetData(ServerTimestampBehaviorstb)const

Retrieves all fields in the document as a map of FieldValues.

Details
Parameters
stb
Configures how server timestamps that have not yet been set to their final value are returned from the snapshot (optional).
Returns
A map containing all fields in the document, or an empty map if the document doesn't exist.

ToString

std::stringToString()const

is_valid

boolis_valid()const

Returns true if thisDocumentSnapshot is valid, false if it is not valid.

An invalidDocumentSnapshot could be the result of:

Details
Returns
true if thisDocumentSnapshot is valid, false if thisDocumentSnapshot is invalid.

metadata

virtualSnapshotMetadatametadata()const

Returns the metadata about this snapshot concerning its source and if it has local modifications.

Details
Returns
SnapshotMetadata about this snapshot.

operator=

DocumentSnapshot&operator=(constDocumentSnapshot&other)

Copy assignment operator.

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

Details
Parameters
other
DocumentSnapshot to copy from.
Returns
Reference to the destinationDocumentSnapshot.

operator=

DocumentSnapshot&operator=(DocumentSnapshot&&other)

Move assignment operator.

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

Details
Parameters
other
DocumentSnapshot to move data from.
Returns
Reference to the destinationDocumentSnapshot.

reference

virtualDocumentReferencereference()const

Returns the document location for which thisDocumentSnapshot contains data.

Details
Returns
DocumentReference of this document location.

~DocumentSnapshot

virtual~DocumentSnapshot()

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-01-23 UTC.