| java.lang.Object | |
| ↳ | com.google.firebase.database.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 onDisconnect
on a Firebase Database ref.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Cancel any disconnect operations that are queued up at this location
| |||||||||||
Cancel any disconnect operations that are queued up at this location
| |||||||||||
Remove the value at this location when the client disconnects
| |||||||||||
Remove the value at this location when the client disconnects
| |||||||||||
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).
| |||||||||||
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).
| |||||||||||
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).
| |||||||||||
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).
| |||||||||||
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).
| |||||||||||
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).
| |||||||||||
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).
| |||||||||||
Ensure the data has the specified child values updated when
the client is disconnected
| |||||||||||
Ensure the data has the specified child values updated when
the client is disconnected
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Cancel any disconnect operations that are queued up at this location
Task for this operation.
Cancel any disconnect operations that are queued up at this location
| listener | A listener that will be triggered once the server has cancelled the operations |
|---|
Remove the value at this location when the client disconnects
Task for this operation.
Remove the value at this location when the client disconnects
| listener | A listener that will be triggered once the server has queued up the operation |
|---|
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.
| 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 |
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.
| 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 |
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.
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
Task for this operation.
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.
| value | The value to be set when a disconnect occurs |
|---|---|
| priority | The priority to be set when a disconnect occurs |
Task for this operation.
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.
| 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 |
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.
| 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 |
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.
| value | The value to be set when a disconnect occurs |
|---|
Task for this operation.
Ensure the data has the specified child values updated when the client is disconnected
| update | The paths to update, along with their desired values |
|---|
Task for this operation.
Ensure the data has the specified child values updated when the client is disconnected
| 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 |