FIRFirestore
@interface FIRFirestore : NSObject
FIRFirestore
represents a Firestore Database and is the entry point for all Firestore
operations.
-
Creates, caches, and returns a
FIRFirestore
using the defaultFIRApp
. Each subsequent invocation returns the sameFIRFirestore
object.Declaration
Objective-C
+ (nonnull instancetype)firestore;
Return Value
The
FIRFirestore
instance. -
Creates, caches, and returns a
FIRFirestore
object for the specified app. Each subsequent invocation returns the sameFIRFirestore
object.Declaration
Objective-C
+ (nonnull instancetype)firestoreForApp:(nonnull FIRApp *)app;
Parameters
app
The
FIRApp
instance to use for authentication and as a source of the Google Cloud Project ID for your Firestore Database. If you want the default instance, you should explicitly set it to[FIRApp defaultApp]
.Return Value
The
FIRFirestore
instance. -
Custom settings used to configure this
FIRFirestore
object.Declaration
Objective-C
@property (readwrite, copy, nonatomic) FIRFirestoreSettings *_Nonnull settings;
-
The Firebase App associated with this Firestore instance.
Declaration
Objective-C
@property (readonly, strong, nonatomic) FIRApp *_Nonnull app;
-
Gets a
FIRCollectionReference
referring to the collection at the specified path within the database.Declaration
Objective-C
- (nonnull FIRCollectionReference *)collectionWithPath: (nonnull NSString *)collectionPath;
Parameters
collectionPath
The slash-separated path of the collection for which to get a
FIRCollectionReference
.Return Value
The
FIRCollectionReference
at the specified collectionPath. -
Gets a
FIRDocumentReference
referring to the document at the specified path within the database.