FirebaseFirestore Framework Reference Stay organized with collections Save and categorize content based on your preferences.
Enumerations
The following enumerations are available globally.
The sources from which an
AggregateQuerycan retrieve its results.See
AggregateQuery.getAggregation(source:completion:).Declaration
Swift
enumAggregateSource:UInt,@uncheckedSendableAn enumeration of document change types.
Declaration
Swift
@frozenenumDocumentChangeType:Int,@uncheckedSendableControls the return value for server timestamps that have not yet been set totheir final value.
Declaration
Swift
enumServerTimestampBehavior:Int,@uncheckedSendableError codes used by Cloud Firestore.
Declaration
Swift
typealiasFirestoreErrorCode.Code._ErrorType=FirestoreErrorCodeAn enum that configures the behavior of
DocumentReference.getDocument()andQuery.getDocuments(). By providing a source enum thegetDocument[s]methods can be configured to fetch results only from the server, only fromthe local cache, or attempt to fetch results from the server and fall back tothe cache (which is the default).Declaration
Swift
enumFirestoreSource:UInt,@uncheckedSendableRepresents the state of bundle loading tasks.
Both
errorandinProgressare final states: the task will be in either an aborted or completed state and there will be no more subsequent updates.Declaration
Swift
enumLoadBundleTaskState:Int,@uncheckedSendableThe source the snapshot listener retrieves data from.
Declaration
Swift
enumListenSource:UInt,@uncheckedSendableUndocumented
Declaration
Swift
publicenumFirestoreDecodingError:ErrorUndocumented
Declaration
Swift
publicenumFirestoreEncodingError:ErrorThe strategy to use when an error occurs during mapping Firestore documentsto the target type of
FirestoreQuery.Declaration
Swift
publicenumDecodingFailureStrategyQuery predicates that can be used to filter results fetched by
FirestoreQuery.Construct predicates using one of the following ways:
letonlyFavourites:QueryPredicate=.whereField("isFavourite",isEqualTo:true)letonlyFavourites2:QueryPredicate=.isEqualTo("isFavourite",true)letonlyFavourites3:QueryPredicate=.where("isFavourite",isEqualTo:true)Declaration
Swift
publicenumQueryPredicate
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 2025-03-11 UTC.