Classes

The following classes are available globally.

  • A FIRCollectionReference object can be used for adding documents, getting document references, and querying for documents (using the methods inherited from FIRQuery).

    Declaration

    Objective-C

    
    @interface FIRCollectionReference : FIRQuery
  • A FIRDocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred (added, modified, or removed).

    Declaration

    Objective-C

    
    @interface FIRDocumentChange : NSObject
  • A FIRDocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. The document at the referenced location may or may not exist. A FIRDocumentReference can also be used to create a FIRCollectionReference to a subcollection.

    Declaration

    Objective-C

    
    @interface FIRDocumentReference : NSObject
  • A FIRDocumentSnapshot contains data read from a document in your Firestore database. The data can be extracted with the data property or by using subscript syntax to access a specific field.

    For a FIRDocumentSnapshot that points to a non-existing document, any data access will return nil. You can use the exists property to explicitly verify a documents existence.

    Declaration

    Objective-C

    
    @interface FIRDocumentSnapshot : NSObject
  • A FIRQueryDocumentSnapshot contains data read from a document in your Firestore database as part of a query. The document is guaranteed to exist and its data can be extracted with the data property or by using subscript syntax to access a specific field.

    A FIRQueryDocumentSnapshot offers the same API surface as a FIRDocumentSnapshot. As deleted documents are not returned from queries, its exists property will always be true and data: will never return nil.

    Declaration

    Objective-C

    
    @interface FIRQueryDocumentSnapshot : FIRDocumentSnapshot
  • A FieldPath refers to a field in a document. The path may consist of a single field name (referring to a top level field in the document), or a list of field names (referring to a nested field in the document).

    Declaration

    Objective-C

    
    @interface FIRFieldPath : NSObject <NSCopying>
  • Sentinel values that can be used when writing document fields with setData() or updateData().

    Declaration

    Objective-C

    
    @interface FIRFieldValue : NSObject
  • FIRFirestore represents a Firestore Database and is the entry point for all Firestore operations.

    Declaration

    Objective-C

    
    @interface FIRFirestore : NSObject
  • An immutable object representing a geographical point in Firestore. The point is represented as a latitude/longitude pair.

    Latitude values are in the range of [-90, 90].