devsite/tools/jazzy/templates

FirebaseFirestore Framework Reference

Enumerations

The following enumerations are available globally.

  • The sources from which an AggregateQuery can retrieve its results.

    See AggregateQuery.getAggregation(source:completion:).

    Declaration

    Swift

    enum AggregateSource : UInt, @unchecked Sendable

  • An enumeration of document change types.

    Declaration

    Swift

    @frozen enum DocumentChangeType : Int, @unchecked Sendable

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

    Declaration

    Swift

    enum ServerTimestampBehavior : Int, @unchecked Sendable

  • Error codes used by Cloud Firestore.

    Declaration

    Swift

    typealias FirestoreErrorCode.Code._ErrorType = FirestoreErrorCode

  • An enum that configures the behavior of DocumentReference.getDocument() and Query.getDocuments(). By providing a source enum the getDocument[s] methods can be configured to fetch results only from the server, only from the local cache, or attempt to fetch results from the server and fall back to the cache (which is the default).

    Declaration

    Swift

    enum FirestoreSource : UInt, @unchecked Sendable

  • Represents the state of bundle loading tasks.

    Both error and inProgress are final states: the task will be in either an aborted or completed state and there will be no more subsequent updates.

    Declaration

    Swift

    enum LoadBundleTaskState : Int, @unchecked Sendable

  • The source the snapshot listener retrieves data from.

    Declaration

    Swift

    enum ListenSource : UInt, @unchecked Sendable

  • Undocumented

    Declaration

    Swift

    public enum FirestoreDecodingError : Error

  • Undocumented

    Declaration

    Swift

    public enum FirestoreEncodingError : Error

  • The strategy to use when an error occurs during mapping Firestore documents to the target type of FirestoreQuery.

    Declaration

    Swift

    public enum DecodingFailureStrategy

  • Query predicates that can be used to filter results fetched by FirestoreQuery.

    Construct predicates using one of the following ways:

    let onlyFavourites: QueryPredicate = .whereField("isFavourite", isEqualTo: true)
let onlyFavourites2: QueryPredicate = .isEqualTo("isFavourite", true)
let onlyFavourites3: QueryPredicate = .where("isFavourite", isEqualTo: true)

    Declaration

    Swift

    public enum QueryPredicate