FirebaseFirestore Framework Reference

Enumerations

The following enumerations are available globally.

  • The sources from which anAggregateQuery can retrieve its results.

    SeeAggregateQuery.getAggregation(source:completion:).

    Declaration

    Objective-C

    enumFIRAggregateSource:NSUInteger{}
  • An enumeration of document change types.

    Declaration

    Objective-C

    enumFIRDocumentChangeType:NSInteger{}
  • Controls the return value for server timestamps that have not yet been set totheir final value.

    Declaration

    Objective-C

    enumFIRServerTimestampBehavior:NSInteger{}
  • Error codes used by Cloud Firestore.

    Declaration

    Objective-C

    enumFIRFirestoreErrorCode:NSInteger{}
  • 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

    Objective-C

    enumFIRFirestoreSource:NSUInteger{}
  • 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

    Objective-C

    enumFIRLoadBundleTaskState:NSInteger{}
  • The source the snapshot listener retrieves data from.

    Declaration

    Objective-C

    enumFIRListenSource:NSUInteger{}

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.