Package-level declarations

Types

Link copied to clipboard
sealed class ChildEvent

A change to a child of a location, emitted by Query.childEvents.

Link copied to clipboard

Receives the changes to the children of a location; see Query.addChildEventListener.

Link copied to clipboard
actual class DatabaseError

A failed operation or cancelled listener, as the Android SDK's DatabaseError; code is one of the constants.

expect class DatabaseError

A failed operation or cancelled listener, as the Android SDK's DatabaseError; code is one of the constants.

actual class DatabaseError

A failed operation or cancelled listener, as the Android SDK's DatabaseError; code is one of the constants.

Link copied to clipboard

Thrown when an operation on the database fails, as the Android SDK's DatabaseException.

Thrown when an operation on the database fails, as the Android SDK's DatabaseException.

Thrown when an operation on the database fails, as the Android SDK's DatabaseException.

Link copied to clipboard
actual open class DatabaseReference : Query

A location in the database that can be read and written, as the Android SDK's DatabaseReference. Values are the platform's natural types: Map, List, String, Boolean, Long and Double (and the platform SDK's own types on Apple platforms and JS); custom classes are not mapped outside Android.

actual open class DatabaseReference : Query
expect open class DatabaseReference : Query

A location in the database that can be read and written, as the Android SDK's DatabaseReference. Values are the platform's natural types: Map, List, String, Boolean, Long and Double (and the platform SDK's own types on Apple platforms and JS); custom classes are not mapped outside Android.

actual open class DatabaseReference : Query
actual open class DatabaseReference : Query
Link copied to clipboard
actual class DataSnapshot

An immutable copy of the data at a location, as the Android SDK's DataSnapshot. value is the natural type of the data: a Map, a List, a String, a Boolean, a Long, a Double or null. Mapping to custom classes through getValue(Class) is Android-only; the GenericTypeIndicator form casts the value on the other platforms.

actual class DataSnapshot
expect class DataSnapshot

An immutable copy of the data at a location, as the Android SDK's DataSnapshot. value is the natural type of the data: a Map, a List, a String, a Boolean, a Long, a Double or null. Mapping to custom classes through getValue(Class) is Android-only; the GenericTypeIndicator form casts the value on the other platforms.

actual class DataSnapshot
actual class DataSnapshot
Link copied to clipboard

Excludes a property from the Android SDK's mapping.

Link copied to clipboard
actual class FirebaseDatabase

The entry point of the Realtime Database, as the Android SDK's com.google.firebase.database.FirebaseDatabase. Persistence settings are accepted on every platform (the JS SDK has no disk persistence, so they are ignored there).

actual class FirebaseDatabase
expect class FirebaseDatabase

The entry point of the Realtime Database, as the Android SDK's com.google.firebase.database.FirebaseDatabase. Persistence settings are accepted on every platform (the JS SDK has no disk persistence, so they are ignored there).

actual class FirebaseDatabase
actual class FirebaseDatabase
Link copied to clipboard
abstract class GenericTypeIndicator<T>

Names the type T a value is mapped to, as the Android SDK's GenericTypeIndicator, for getValue calls such as snapshot.getValue(object : GenericTypeIndicator<Map<String, Long>>() {}).

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IgnoreExtraProperties

Makes the Android SDK's mapper ignore properties of the data that the class does not have.

Link copied to clipboard
interface Logger

The logging of the Realtime Database, as the Android SDK's Logger; Level is passed to FirebaseDatabase.setLogLevel.

Link copied to clipboard
actual class MutableData

The data of a location inside a transaction, as the Android SDK's MutableData: value is read and then set to the new data before the Transaction.Handler returns Transaction.success.

actual class MutableData
expect class MutableData

The data of a location inside a transaction, as the Android SDK's MutableData: value is read and then set to the new data before the Transaction.Handler returns Transaction.success.

actual class MutableData

The data of a transaction as a JS value tree: the JS SDK's transaction receives the current value and returns the new one, so root holds the value being edited and each child refers to a path in it.

actual class MutableData

The data of a transaction as a JS value tree: the JS SDK's transaction receives the current value and returns the new one, so root holds the value being edited and each child refers to a path in it.

Link copied to clipboard
actual class OnDisconnect

Writes the server applies when this client disconnects, as the Android SDK's OnDisconnect; obtained from DatabaseReference.onDisconnect. Each operation completes once the server has registered it.

actual class OnDisconnect
expect class OnDisconnect

Writes the server applies when this client disconnects, as the Android SDK's OnDisconnect; obtained from DatabaseReference.onDisconnect. Each operation completes once the server has registered it.

actual class OnDisconnect
actual class OnDisconnect
Link copied to clipboard

The name of a property in the database, when it differs from the member's name.

Link copied to clipboard
actual open class Query

A read of a location with ordering and filtering, as the Android SDK's Query. Listeners are called on the thread the platform SDK delivers events on. keepSynced is in nonJsMain (the JS SDK has no equivalent).

actual open class Query
expect open class Query

A read of a location with ordering and filtering, as the Android SDK's Query. Listeners are called on the thread the platform SDK delivers events on. keepSynced is in nonJsMain (the JS SDK has no equivalent).

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

Values the server computes on write, as the Android SDK's ServerValue; each is written like any other value.

expect class ServerValue

Values the server computes on write, as the Android SDK's ServerValue; each is written like any other value.

actual class ServerValue

The server values as the .sv maps the platform SDKs and the backend understand.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class ThrowOnExtraProperties

Makes the Android SDK's mapper fail on properties of the data that the class does not have.

Link copied to clipboard
actual class Transaction

A transaction on a location, as the Android SDK's Transaction: Handler.doTransaction returns success or abort.

expect class Transaction

A transaction on a location, as the Android SDK's Transaction: Handler.doTransaction returns success or abort.

actual class Transaction

A transaction on a location, as the Android SDK's Transaction: Handler.doTransaction returns success or abort.

Link copied to clipboard

Receives the data at a location and its changes; see Query.addValueEventListener.

Properties

Link copied to clipboard

The changes to the children of this location as a Flow, which fails if the listener is cancelled.

Link copied to clipboard

The FirebaseDatabase of the default FirebaseApp; the Android SDK's Firebase.database.

Link copied to clipboard

The data at this location and every change to it as a Flow, which fails if the listener is cancelled.

Functions

Link copied to clipboard
inline fun <T> DataSnapshot.getValue(): T?

The data as T, as the Android SDK's reified getValue; on Apple platforms and JS a cast of DataSnapshot.value.

inline fun <T> MutableData.getValue(): T?

The data as T, as the Android SDK's reified getValue; on Apple platforms and JS a cast of MutableData.value.

Link copied to clipboard
inline fun <T> Query.values(): Flow<T?>

The data at this location and every change to it as T (see getValue).