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 fromFIRQuery
).Declaration
Swift
class CollectionReference : Query
-
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
Swift
class DocumentChange : 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. AFIRDocumentReference
can also be used to create aFIRCollectionReference
to a subcollection.Declaration
Swift
class DocumentReference : NSObject
-
A
FIRDocumentSnapshot
contains data read from a document in your Firestore database. The data can be extracted with thedata
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 returnnil
. You can use theexists
property to explicitly verify a documents existence.Declaration
Swift
class DocumentSnapshot : 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 thedata
property or by using subscript syntax to access a specific field.A
FIRQueryDocumentSnapshot
offers the same API surface as aFIRDocumentSnapshot
. As deleted documents are not returned from queries, itsexists
property will always be true anddata:
will never returnnil
.Declaration
Swift
class QueryDocumentSnapshot : DocumentSnapshot
-
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
Swift
class FieldPath : NSObject, NSCopying
-
Sentinel values that can be used when writing document fields with setData() or updateData().
Declaration
Swift
class FieldValue : NSObject
-
FIRFirestore
represents a Firestore Database and is the entry point for all Firestore operations.Declaration
Swift
class Firestore : NSObject
-
Settings used to configure a
FIRFirestore
instance.Declaration
Swift
class FirestoreSettings : NSObject, NSCopying
-
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]. Longitude values are in the range of [-180, 180].
Declaration
Swift
class GeoPoint : NSObject, NSCopying
-
A
FIRQuery
refers to a Query which you can read or listen to. You can also construct refinedFIRQuery
objects by adding filters and ordering.Declaration
Swift
class Query : NSObject
-
A
FIRQuerySnapshot
contains zero or moreFIRDocumentSnapshot
objects. It can be enumerated usingfor … in documentSet.documents
and its size can be inspected withisEmpty
andcount
.Declaration
Swift
class QuerySnapshot : NSObject
-
Metadata about a snapshot, describing the state of the snapshot.
Declaration
Swift
class SnapshotMetadata : NSObject