FirebaseFirestore Framework Reference

Enumerations

The following enumerations are available globally.

  • The sources from which anAggregateQuery can retrieve its results.

    SeeAggregateQuery.getAggregation(source:completion:).

    Declaration

    Swift

    enumAggregateSource:UInt,@uncheckedSendable
  • An enumeration of document change types.

    Declaration

    Swift

    @frozenenumDocumentChangeType:Int,@uncheckedSendable
  • Controls the return value for server timestamps that have not yet been set totheir final value.

    Declaration

    Swift

    enumServerTimestampBehavior:Int,@uncheckedSendable
  • Error codes used by Cloud Firestore.

    Declaration

    Swift

    typealiasFirestoreErrorCode.Code._ErrorType=FirestoreErrorCode
  • An enum that configures the behavior ofDocumentReference.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,@uncheckedSendable
  • Represents the state of bundle loading tasks.

    Botherror andinProgress are 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,@uncheckedSendable
  • The source the snapshot listener retrieves data from.

    Declaration

    Swift

    enumListenSource:UInt,@uncheckedSendable
  • Undocumented

    Declaration

    Swift

    publicenumFirestoreDecodingError:Error
  • Undocumented

    Declaration

    Swift

    publicenumFirestoreEncodingError:Error
  • The strategy to use when an error occurs during mapping Firestore documentsto the target type ofFirestoreQuery.

    Declaration

    Swift

    publicenumDecodingFailureStrategy
  • Query predicates that can be used to filter results fetched byFirestoreQuery.

    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.