Package-level declarations

Types

Link copied to clipboard
data class ChildEvent

Used to emit events about changes in the child locations of a given Query when using the childEvents Flow.

Link copied to clipboard
actual typealias DatabaseException = com.google.firebase.database.DatabaseException
expect class DatabaseException(message: String?, cause: Throwable?) : RuntimeException

Exception that gets thrown when an operation on Firebase Database fails.

actual class DatabaseException(message: String?, cause: Throwable?) : RuntimeException
actual class DatabaseException(message: String?, cause: Throwable?) : RuntimeException
actual typealias DatabaseException = com.google.firebase.database.DatabaseException
Link copied to clipboard

A Firebase reference represents a particular location in your Database and can be used for reading or writing data to that Database location.

Link copied to clipboard
actual class DataSnapshot
expect class DataSnapshot

A DataSnapshot instance contains data from a Firebase Database location. Any time you read Database data, you receive the data as a DataSnapshot.

actual class DataSnapshot
actual class DataSnapshot
actual class DataSnapshot
Link copied to clipboard
actual class FirebaseDatabase
expect class FirebaseDatabase

The entry point for accessing a Firebase Database. You can get an instance by calling Firebase.database. To access a location in the database and read or write data, use FirebaseDatabase.reference.

actual class FirebaseDatabase
actual class FirebaseDatabase
actual class FirebaseDatabase
Link copied to clipboard

The OnDisconnect class is used to manage operations that will be run on the server when this client disconnects. It can be used to add or remove data based on a client's connection status. It is very useful in applications looking for 'presence' functionality.

Link copied to clipboard
actual open class Query
expect open class Query

The Query class (and its subclass, DatabaseReference) are used for reading data. Listeners are attached, and they will be triggered when the corresponding data changes.

actual open class Query
actual open class Query
actual open class Query
Link copied to clipboard
@Serializable(with = ServerValueSerializer::class)
actual class ServerValue

Represents a Firebase ServerValue.

@Serializable(with = ServerValueSerializer::class)
expect class ServerValue

Represents a Firebase ServerValue.

@Serializable(with = ServerValueSerializer::class)
actual class ServerValue

Represents a Firebase ServerValue.

@Serializable(with = ServerValueSerializer::class)
actual class ServerValue

Represents a Firebase ServerValue.

@Serializable(with = ServerValueSerializer::class)
actual class ServerValue

Represents a Firebase ServerValue.

Link copied to clipboard
object ServerValueSerializer : KSerializer<ServerValue>

Serializer for ServerValue. Must be used with FirebaseEncoder/FirebaseDecoder.

Properties

Link copied to clipboard
val DataSnapshot.android: DataSnapshot
val DatabaseReference.android: DatabaseReference
val FirebaseDatabase.android: FirebaseDatabase
val OnDisconnect.android: OnDisconnect
val Query.android: Query
val DataSnapshot.android: DataSnapshot
val DatabaseReference.android: DatabaseReference
val FirebaseDatabase.android: FirebaseDatabase
val OnDisconnect.android: OnDisconnect
val Query.android: Query
Link copied to clipboard
val DataSnapshot.ios: FIRDataSnapshot
val DatabaseReference.ios: FIRDatabaseReference
val FirebaseDatabase.ios: FIRDatabase
val OnDisconnect.ios: FIRDatabaseReference
val Query.ios: FIRDatabaseQuery
Link copied to clipboard
val DataSnapshot.js: DataSnapshot
val FirebaseDatabase.js: Database
val OnDisconnect.js: OnDisconnect
val Query.js: Query

Functions

Link copied to clipboard

Returns the FirebaseDatabase instance of the given FirebaseApp.

Returns the FirebaseDatabase instance for the specified url.

Returns the FirebaseDatabase instance of the given FirebaseApp and url.

Link copied to clipboard
fun ChildEvent.Type.toEventType(): FIRDataEventType