Package-level declarations

Types

Link copied to clipboard
external interface AggregateField
Link copied to clipboard
external interface AggregateQuerySnapshot
Link copied to clipboard
external interface CollectionReference : Query
Link copied to clipboard
external interface DocumentChange
Link copied to clipboard
external class DocumentReference
Link copied to clipboard
external interface DocumentSnapshot
Link copied to clipboard
external class FieldPath(fieldNames: String)
Link copied to clipboard
external class FieldValue
Link copied to clipboard
external interface Firestore
Link copied to clipboard
external interface FirestoreLocalCache
Link copied to clipboard
external class GeoPoint(latitude: Double, longitude: Double)
Link copied to clipboard
external interface MemoryCacheSettings
Link copied to clipboard
Link copied to clipboard
external interface MemoryGarbageCollector
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface PersistentCacheSettings
Link copied to clipboard
Link copied to clipboard
external interface PersistentTabManager
Link copied to clipboard
external interface Query
Link copied to clipboard
external interface QueryConstraint
Link copied to clipboard
external interface QuerySnapshot
Link copied to clipboard
external interface SnapshotMetadata
Link copied to clipboard
external class Timestamp(seconds: Double, nanoseconds: Double)
Link copied to clipboard
external interface Transaction
Link copied to clipboard
external interface WriteBatch

Functions

Link copied to clipboard
external fun addDoc(reference: CollectionReference, data: <Error class: unknown class>): <Error class: unknown class><DocumentReference>
Link copied to clipboard
external fun and(vararg queryConstraints: QueryConstraint): QueryConstraint
Link copied to clipboard
external fun arrayRemove(vararg elements: <Error class: unknown class>?): FieldValue
Link copied to clipboard
external fun arrayUnion(vararg elements: <Error class: unknown class>?): FieldValue
Link copied to clipboard
external fun average(field: FieldPath): AggregateField
external fun average(field: String): AggregateField
Link copied to clipboard
external fun clearIndexedDbPersistence(firestore: Firestore): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun collection(reference: DocumentReference, collectionPath: String): CollectionReference
external fun collection(firestore: Firestore, collectionPath: String): CollectionReference
Link copied to clipboard
external fun collectionGroup(firestore: Firestore, collectionId: String): Query
Link copied to clipboard
external fun connectFirestoreEmulator(firestore: Firestore, host: String, port: Int, options: <Error class: unknown class>? = definedExternally)
Link copied to clipboard
external fun deleteDoc(reference: DocumentReference): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun deleteField(): FieldValue
Link copied to clipboard
external fun disableNetwork(firestore: Firestore): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun doc(firestore: CollectionReference): DocumentReference
external fun doc(firestore: CollectionReference, documentPath: String): DocumentReference
external fun doc(firestore: Firestore, documentPath: String): DocumentReference
Link copied to clipboard
external fun documentId(): FieldPath
Link copied to clipboard
external fun enableIndexedDbPersistence(firestore: Firestore, persistenceSettings: <Error class: unknown class>? = definedExternally): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun enableNetwork(firestore: Firestore): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun endAt(document: DocumentSnapshot): QueryConstraint
external fun endAt(vararg fieldValues: <Error class: unknown class>?): QueryConstraint
Link copied to clipboard
external fun endBefore(document: DocumentSnapshot): QueryConstraint
external fun endBefore(vararg fieldValues: <Error class: unknown class>?): QueryConstraint
Link copied to clipboard
external fun getAggregateFromServer(query: Query, aggregateSpec: <Error class: unknown class>): <Error class: unknown class><AggregateQuerySnapshot>
Link copied to clipboard
external fun getCountFromServer(query: Query): <Error class: unknown class><AggregateQuerySnapshot>
Link copied to clipboard
external fun getDoc(reference: DocumentReference, options: <Error class: unknown class>? = definedExternally): <Error class: unknown class><DocumentSnapshot>
Link copied to clipboard
external fun getDocFromCache(reference: DocumentReference): <Error class: unknown class><DocumentSnapshot>
Link copied to clipboard
external fun getDocFromServer(reference: DocumentReference): <Error class: unknown class><DocumentSnapshot>
Link copied to clipboard
external fun getDocs(query: Query): <Error class: unknown class><QuerySnapshot>
Link copied to clipboard
external fun getDocsFromCache(query: Query): <Error class: unknown class><QuerySnapshot>
Link copied to clipboard
external fun getDocsFromServer(query: Query): <Error class: unknown class><QuerySnapshot>
Link copied to clipboard
external fun getFirestore(app: FirebaseApp? = definedExternally, databaseId: String? = definedExternally): Firestore
Link copied to clipboard
external fun increment(n: Double): FieldValue
external fun increment(n: Int): FieldValue
Link copied to clipboard
external fun initializeFirestore(app: FirebaseApp, settings: <Error class: unknown class>? = definedExternally, databaseId: String? = definedExternally): Firestore
Link copied to clipboard
external fun limit(limit: Double): QueryConstraint
Link copied to clipboard
external fun limitToLast(limit: Double): QueryConstraint
Link copied to clipboard
external fun memoryLocalCache(settings: <Error class: unknown class>): MemoryLocalCache
Link copied to clipboard
external fun memoryLruGarbageCollector(settings: <Error class: unknown class>? = definedExternally): MemoryLruGarbageCollector
Link copied to clipboard
external fun onSnapshot(reference: DocumentReference, next: (snapshot: DocumentSnapshot) -> Unit, error: (<Error class: unknown class>) -> Unit): Unsubscribe
external fun onSnapshot(reference: Query, next: (snapshot: QuerySnapshot) -> Unit, error: (<Error class: unknown class>) -> Unit): Unsubscribe
external fun onSnapshot(reference: DocumentReference, options: <Error class: unknown class>, next: (snapshot: DocumentSnapshot) -> Unit, error: (<Error class: unknown class>) -> Unit): Unsubscribe
external fun onSnapshot(reference: Query, options: <Error class: unknown class>, next: (snapshot: QuerySnapshot) -> Unit, error: (<Error class: unknown class>) -> Unit): Unsubscribe
Link copied to clipboard
external fun or(vararg queryConstraints: QueryConstraint): QueryConstraint
Link copied to clipboard
external fun orderBy(field: FieldPath, direction: String): QueryConstraint
external fun orderBy(field: String, direction: String): QueryConstraint
Link copied to clipboard
external fun persistentLocalCache(settings: <Error class: unknown class>): PersistentLocalCache
Link copied to clipboard
Link copied to clipboard
external fun persistentSingleTabManager(settings: <Error class: unknown class>? = definedExternally): PersistentTabManager
Link copied to clipboard
external fun query(query: Query, vararg queryConstraints: QueryConstraint): Query
Link copied to clipboard
Link copied to clipboard
external fun runTransaction(firestore: Firestore, updateFunction: (transaction: Transaction) -> <Error class: unknown class><<Error class: unknown class>?>, options: <Error class: unknown class>? = definedExternally): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun serverTimestamp(): FieldValue
Link copied to clipboard
external fun setDoc(documentReference: DocumentReference, data: <Error class: unknown class>, options: <Error class: unknown class>? = definedExternally): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun setLogLevel(logLevel: String)
Link copied to clipboard
external fun startAfter(vararg fieldValues: <Error class: unknown class>?): QueryConstraint
Link copied to clipboard
external fun startAt(document: DocumentSnapshot): QueryConstraint
external fun startAt(vararg fieldValues: <Error class: unknown class>?): QueryConstraint
Link copied to clipboard
external fun sum(field: FieldPath): AggregateField
external fun sum(field: String): AggregateField
Link copied to clipboard
external fun terminate(firestore: Firestore): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun updateDoc(reference: DocumentReference, data: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>?>
external fun updateDoc(reference: DocumentReference, field: FieldPath, value: <Error class: unknown class>?, vararg moreFieldsAndValues: <Error class: unknown class>?): <Error class: unknown class><<Error class: unknown class>?>
external fun updateDoc(reference: DocumentReference, field: String, value: <Error class: unknown class>?, vararg moreFieldsAndValues: <Error class: unknown class>?): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun waitForPendingWrites(firestore: Firestore): <Error class: unknown class><<Error class: unknown class>?>
Link copied to clipboard
external fun where(field: FieldPath, opStr: String, value: <Error class: unknown class>?): QueryConstraint
external fun where(field: String, opStr: String, value: <Error class: unknown class>?): QueryConstraint
Link copied to clipboard
external fun writeBatch(firestore: Firestore): WriteBatch