com.firebase.geofire

Interface GeoQueryDataEventListener

public interface GeoQueryDataEventListener

GeoQuery notifies listeners with this interface about dataSnapshots that entered, exited, or moved within the query.

Method Summary

Modifier and Type	Method and Description
void	onDataChanged(com.google.firebase.database.DataSnapshot dataSnapshot, GeoLocation location) Called if a dataSnapshot changed within the search area.
void	onDataEntered(com.google.firebase.database.DataSnapshot dataSnapshot, GeoLocation location) Called if a dataSnapshot entered the search area of the GeoQuery.
void	onDataExited(com.google.firebase.database.DataSnapshot dataSnapshot) Called if a datasnapshot exited the search area of the GeoQuery.
void	onDataMoved(com.google.firebase.database.DataSnapshot dataSnapshot, GeoLocation location) Called if a dataSnapshot moved within the search area.
void	onGeoQueryError(com.google.firebase.database.DatabaseError error) Called in case an error occurred while retrieving locations for a query, e.g.
void	onGeoQueryReady() Called once all initial GeoFire data has been loaded and the relevant events have been fired for this query.

Method Detail

onDataEntered

void onDataEntered(com.google.firebase.database.DataSnapshot dataSnapshot,
                   GeoLocation location)

Called if a dataSnapshot entered the search area of the GeoQuery. This method is called for every dataSnapshot currently in the search area at the time of adding the listener. This method is once per datasnapshot, and is only called again if onDataExited was called in the meantime.

Parameters:

dataSnapshot - The associated dataSnapshot that entered the search area

location - The location for this dataSnapshot as a GeoLocation object

onDataExited

void onDataExited(com.google.firebase.database.DataSnapshot dataSnapshot)

Called if a datasnapshot exited the search area of the GeoQuery. This is method is only called if onDataEntered was called for the datasnapshot.

Parameters:

dataSnapshot - The associated dataSnapshot that exited the search area

onDataMoved

void onDataMoved(com.google.firebase.database.DataSnapshot dataSnapshot,
                 GeoLocation location)

Called if a dataSnapshot moved within the search area. This method can be called multiple times.

Parameters:

dataSnapshot - The associated dataSnapshot that moved within the search area

location - The location for this dataSnapshot as a GeoLocation object

onDataChanged

void onDataChanged(com.google.firebase.database.DataSnapshot dataSnapshot,
                   GeoLocation location)

Called if a dataSnapshot changed within the search area. An onDataMoved() is always followed by onDataChanged() but it is be possible to see onDataChanged() without an preceding onDataMoved(). This method can be called multiple times for a single location change, due to the way the Realtime Database handles floating point numbers. Note: this method is not related to ValueEventListener#onDataChange(DataSnapshot).

Parameters:

dataSnapshot - The associated dataSnapshot that moved within the search area

location - The location for this dataSnapshot as a GeoLocation object

onGeoQueryReady

void onGeoQueryReady()

Called once all initial GeoFire data has been loaded and the relevant events have been fired for this query. Every time the query criteria is updated, this observer will be called after the updated query has fired the appropriate dataSnapshot entered or dataSnapshot exited events.

onGeoQueryError

void onGeoQueryError(com.google.firebase.database.DatabaseError error)

Called in case an error occurred while retrieving locations for a query, e.g. violating security rules.

Parameters:

error - The error that occurred while retrieving the query