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

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

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

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

Link copied to clipboard

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.

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
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.

Link copied to clipboard
@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)
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.

Link copied to clipboard
object ServerValueSerializer : KSerializer<ServerValue>

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

Properties

Link copied to clipboard
Link copied to clipboard

Returns the FirebaseDatabase instance of the default FirebaseApp.

The underlying Firebase JS SDK database.

The underlying Firebase JS SDK database.

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

The underlying Firebase iOS SDK object.

val OnDisconnect.ios: FIRDatabaseReference

The underlying Firebase iOS SDK reference the disconnect operations are registered on.

Link copied to clipboard

The underlying Firebase JS SDK object.

The underlying Firebase JS SDK object.

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