firebase-database/io.github.corneloaie.firebase.database/OnDisconnect

OnDisconnect

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.

Instances of this class are obtained by calling DatabaseReference.onDisconnect on a Firebase Database ref.

Properties

android

val OnDisconnect.android: OnDisconnect

The underlying Firebase Android SDK object.

compat

val compat: OnDisconnect

The Android-SDK-shaped com.google.firebase.database.OnDisconnect this wraps.

database

val OnDisconnect.~~database~~: FirebaseDatabase

val OnDisconnect.database: Database

The underlying Firebase JS SDK database.

val OnDisconnect.database: Database

The underlying Firebase JS SDK database.

ios

val OnDisconnect.ios: FIRDatabaseReference

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

val OnDisconnect.js: OnDisconnect

The underlying Firebase JS SDK object.

val OnDisconnect.js: OnDisconnect

The underlying Firebase JS SDK object.

persistenceEnabled

val OnDisconnect.~~persistenceEnabled~~: Boolean

Functions

cancel

suspend fun cancel()

Cancel any disconnect operations that are queued up at this location

removeValue

suspend fun removeValue()

Remove the value at this location when the client disconnects

setValue

inline suspend fun <T> ~~setValue~~(value: T?, encodeDefaults: Boolean)

inline suspend fun <T> setValue(value: T?, buildSettings: EncodeSettings.Builder.() -> Unit = {})

suspend fun <T> ~~setValue~~(strategy: SerializationStrategy<T>, value: T, encodeDefaults: Boolean)

inline suspend fun <T> setValue(strategy: SerializationStrategy<T>, value: T, buildSettings: EncodeSettings.Builder.() -> Unit = {})

Ensure the data at this location is set to the specified value when the client is disconnected (due to closing the browser, navigating to a new page, or network issues).

updateChildren

suspend fun ~~updateChildren~~(update: Map<String, Any?>, encodeDefaults: Boolean)

inline suspend fun updateChildren(update: Map<String, Any?>, buildSettings: EncodeSettings.Builder.() -> Unit = {})

Ensure the data has the specified child values updated when the client is disconnected