OnDisconnect
extends Object| java.lang.Object | |
| ↳ | com.google.firebase.database.OnDisconnect |
Class Overview
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 onDisconnect on a Firebase Database ref.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
cancel(DatabaseReference.CompletionListener listener)
Cancel any disconnect operations that are queued up at this location
| ||||||||||
| ApiFuture<Void> |
cancelAsync()
Cancel any disconnect operations that are queued up at this location
| ||||||||||
| void |
removeValue(DatabaseReference.CompletionListener listener)
Remove the value at this location when the client disconnects
| ||||||||||
| ApiFuture<Void> |
removeValueAsync()
Remove the value at this location when the client disconnects
| ||||||||||
| void |
setValue(Object value, double priority, DatabaseReference.CompletionListener listener)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
| ||||||||||
| void |
setValue(Object value, DatabaseReference.CompletionListener listener)
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).
| ||||||||||
| void |
setValue(Object value, Map priority, DatabaseReference.CompletionListener listener)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
| ||||||||||
| void |
setValue(Object value, String priority, DatabaseReference.CompletionListener listener)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
| ||||||||||
| ApiFuture<Void> |
setValueAsync(Object value, double priority)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
| ||||||||||
| ApiFuture<Void> |
setValueAsync(Object value)
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).
| ||||||||||
| ApiFuture<Void> |
setValueAsync(Object value, String priority)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
| ||||||||||
| void |
updateChildren(Map<String, Object> update, DatabaseReference.CompletionListener listener)
Ensure the data has the specified child values updated when the client is disconnected
| ||||||||||
| ApiFuture<Void> |
updateChildrenAsync(Map<String, Object> update)
Ensure the data has the specified child values updated when the client is disconnected
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public void cancel (DatabaseReference.CompletionListener listener)
Cancel any disconnect operations that are queued up at this location
Parameters
| listener | A listener that will be triggered once the server has cancelled the operations |
|---|
public ApiFuture<Void> cancelAsync ()
Cancel any disconnect operations that are queued up at this location
Returns
- The ApiFuture for this operation.
public void removeValue (DatabaseReference.CompletionListener listener)
Remove the value at this location when the client disconnects
Parameters
| listener | A listener that will be triggered once the server has queued up the operation |
|---|
public ApiFuture<Void> removeValueAsync ()
Remove the value at this location when the client disconnects
Returns
- The ApiFuture for this operation.
public void setValue (Object value, double priority, DatabaseReference.CompletionListener listener)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
| listener | A listener that will be triggered once the server has queued up the operation |
public void setValue (Object value, DatabaseReference.CompletionListener listener)
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).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|---|
| listener | A listener that will be triggered once the server has queued up the operation |
public void setValue (Object value, Map priority, DatabaseReference.CompletionListener listener)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
| listener | A listener that will be triggered once the server has queued up the operation |
public void setValue (Object value, String priority, DatabaseReference.CompletionListener listener)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
| listener | A listener that will be triggered once the server has queued up the operation |
public ApiFuture<Void> setValueAsync (Object value, double priority)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
Returns
- The ApiFuture for this operation.
public ApiFuture<Void> setValueAsync (Object value)
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).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|
Returns
- The ApiFuture for this operation.
public ApiFuture<Void> setValueAsync (Object value, String priority)
Ensure the data at this location is set to the specified value and priority when the client is
disconnected (due to closing the browser, navigating to a new page, or network issues).
This method is especially useful for implementing "presence" systems, where a value should be
changed or cleared when a user disconnects so that they appear "offline" to other users.
Parameters
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
Returns
- The ApiFuture for this operation.
public void updateChildren (Map<String, Object> update, DatabaseReference.CompletionListener listener)
Ensure the data has the specified child values updated when the client is disconnected
Parameters
| update | The paths to update, along with their desired values |
|---|---|
| listener | A listener that will be triggered once the server has queued up the operation |
public ApiFuture<Void> updateChildrenAsync (Map<String, Object> update)
Ensure the data has the specified child values updated when the client is disconnected
Parameters
| update | The paths to update, along with their desired values |
|---|
Returns
- The ApiFuture for this operation.