Classes
The following classes are available globally.
-
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. AFIRDocumentReference
can also be used to create aFIRCollectionReference
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 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
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 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
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
-
Settings used to configure a
FIRFirestore
instance.Declaration
Objective-C
@interface FIRFirestoreSettings : 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
Objective-C
@interface FIRGeoPoint : 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
Objective-C
@interface FIRQuery : 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
Objective-C
@interface FIRQuerySnapshot : NSObject
-
Metadata about a snapshot, describing the state of the snapshot.
Declaration
Objective-C
@interface FIRSnapshotMetadata : NSObject
-
A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are
smeared
so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.See
https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto for the reference timestamp definition.Declaration
Objective-C
@interface FIRTimestamp : NSObject <NSCopying>
-
FIRTransaction
provides methods to read and write data within a transaction.See
FIRFirestore#transaction:completion:Declaration
Objective-C
@interface FIRTransaction : NSObject