com.firebase.geofire

Interface GeoQueryEventListener

public interface GeoQueryEventListener

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

Method Summary

Methods

Modifier and Type	Method and Description
void	onGeoQueryError(com.firebase.client.FirebaseError 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.
void	onKeyEntered(String key, GeoLocation location) Called if a key entered the search area of the GeoQuery.
void	onKeyExited(String key) Called if a key exited the search area of the GeoQuery.
void	onKeyMoved(String key, GeoLocation location) Called if a key moved within the search area.

Method Detail

onKeyEntered

void onKeyEntered(String key,
                GeoLocation location)

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

Parameters:

key - The key that entered the search area

location - The location for this key as a GeoLocation object

onKeyExited

void onKeyExited(String key)

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

Parameters:

key - The key that exited the search area

onKeyMoved

void onKeyMoved(String key,
              GeoLocation location)

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

Parameters:

key - The key that moved within the search area

location - The location for this key 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 key entered or key exited events.

onGeoQueryError

void onGeoQueryError(com.firebase.client.FirebaseError 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