Annotations
| DocumentId | Annotation used to mark a POJO property to be
automatically populated with the document's ID when the POJO is created from a Cloud
Firestore document (for example, via
toObject(Class
). |
| Exclude | Marks a field as excluded from the database instance. |
| IgnoreExtraProperties | Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation. |
| PropertyName | Marks a field to be renamed when serialized. |
| ServerTimestamp | Annotation used to mark a timestamp field to be populated with a server timestamp. |
| ThrowOnExtraProperties | Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown. |
Interfaces
| EventListener<T> | An interface for event listeners. |
| ListenerRegistration | Represents a listener that can be removed by
calling remove(). |
| Transaction.Function<TResult> | An interface for providing code to be executed within a transaction context. |
| WriteBatch.Function | An interface for providing code to be executed
within a WriteBatch context. |
Classes
| Blob | Immutable class representing an array of bytes in Cloud Firestore. |
| CollectionReference | A CollectionReference can be used for
adding documents, getting document references, and querying for documents (using the
methods inherited from Query). |
| DocumentChange | A DocumentChange represents a change
to the documents matching a query. |
| DocumentReference | A DocumentReference refers to a
document location in a Cloud Firestore database and can be used to write, read, or
listen to the location. |
| DocumentSnapshot | A DocumentSnapshot contains data read
from a document in your Cloud Firestore database. |
| FieldPath | A FieldPath refers to a field in a
document. |
| FieldValue | Sentinel values that can be used when writing
document fields with set() or update(). |
| FirebaseFirestore | Represents a Cloud Firestore database and is the entry point for all Cloud Firestore operations. |
| FirebaseFirestoreSettings | Settings used to configure a FirebaseFirestore
instance. |
| FirebaseFirestoreSettings.Builder | A Builder for creating
FirebaseFirestoreSettings. |
| GeoPoint | Immutable class representing a
GeoPoint in Cloud Firestore |
| Query | A Query which you can read or listen
to. |
| QueryDocumentSnapshot | A QueryDocumentSnapshot contains data
read from a document in your Cloud Firestore database as part of a query. |
| QuerySnapshot | A QuerySnapshot contains the results
of a query. |
| SetOptions | An options object that configures the behavior of
set() calls. |
| SnapshotMetadata | Metadata about a snapshot, describing the state of the snapshot. |
| Transaction | A Transaction is passed to a Function
to provide the methods to read and write data within the transaction
context. |
| WriteBatch | A write batch, used to perform multiple writes as a single atomic unit. |
Enums
| DocumentChange.Type | An enumeration of snapshot diff types. |
| DocumentSnapshot.ServerTimestampBehavior | Controls the return value for server timestamps that have not yet been set to their final value. |
| FirebaseFirestoreException.Code | The set of Cloud Firestore status codes. |
| MetadataChanges | Indicates whether metadata-only changes (that is,
only DocumentSnapshot.getMetadata() or
QuerySnapshot.getMetadata() changed) should trigger snapshot
events. |
| Query.Direction | An enum for the direction of a sort. |
| Source | Configures the behavior of get()
calls on DocumentReference
and Query. |
Exceptions
| FirebaseFirestoreException | A class of exceptions thrown by Cloud Firestore. |