Realtime Database API Reference
This section documents all Firebase Realtime Database Blueprint nodes provided by the plugin. These nodes allow you to read and write JSON data, listen for realtime updates, manage presence, and control connection state.
All Realtime Database nodes require Firebase to be successfully initialized before use.
Value Operations
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Value | Path (string), Json (string) |
– | Sets a JSON value at the specified Realtime Database path, replacing any existing data. |
| Update Value | Path (string), Json (string) |
– | Updates specific child fields at the specified path using a JSON object, without overwriting the entire node. |
| Get Value | Path (string) |
On Success (Path, Json): Called when the value is read successfully. On Failure (Path, Error Message, Error Code): Called if the read operation fails. |
Asynchronously reads the value stored at the specified path. |
| Remove Value | Path (string) |
– | Removes the value at the specified Realtime Database path. |
| Push Value | Path (string), Json (string) |
On Success (Path, Key): Called when a new child is created successfully. On Failure (Path, Error Message, Error Code): Called if the push operation fails. |
Pushes a new child node with an auto-generated key to the specified path. |
Realtime Listeners
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Listen Value | Path (string) |
Return (Handle): Listener handle. On Value (Path, Json): Called when the value changes. On Error (Path, Error Message, Error Code): Called on listener error. |
Listens for value changes at the specified path. |
| Listen Child Added | Path (string) |
Return (Handle): Listener handle. On Added (Path, Key, Json): Called when a child is added. On Error (Path, Error Message, Error Code): Called on listener error. |
Listens for child added events at the specified path. |
| Listen Child Changed | Path (string) |
Return (Handle): Listener handle. On Changed (Path, Key, Json): Called when a child is changed. On Error (Path, Error Message, Error Code): Called on listener error. |
Listens for child changed events at the specified path. |
| Listen Child Removed | Path (string) |
Return (Handle): Listener handle. On Removed (Path, Key): Called when a child is removed. On Error (Path, Error Message, Error Code): Called on listener error. |
Listens for child removed events at the specified path. |
| Stop Listener | Handle (int32) |
– | Stops a previously registered Realtime Database listener using its handle. |
Presence
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set On Disconnect Set | Path (string), Json (string) |
– | Sets a value that will be written to the specified path when the client disconnects. |
| Set On Disconnect Remove | Path (string) |
– | Removes the value at the specified path automatically when the client disconnects. |
| Cancel On Disconnect | Path (string) |
– | Cancels any previously configured on-disconnect operation for the specified path. |
Connection
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Listen Connection State | – | On Changed (bConnected): Called when the connection state changes. | Listens for changes in the Realtime Database connection state. |
| Go Online | – | – | Forces the Realtime Database client to go online. |
| Go Offline | – | – | Forces the Realtime Database client to go offline. |