org.imperiumlabs.geofirestore

Interface GeoQueryEventListener

public interface GeoQueryEventListener

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

Method Summary

Modifier and Type	Method and Description
void	onGeoQueryError(java.lang.Exception exception) Called in case an exception occurred while retrieving locations for a query, e.g.
void	onGeoQueryReady() Called once all initial GeoFirestore data has been loaded and the relevant events have been fired for this query.
void	onKeyEntered(java.lang.String documentID, com.google.firebase.firestore.GeoPoint location) Called if a documentID entered the search area of the GeoQuery.
void	onKeyExited(java.lang.String documentID) Called if a documentID exited the search area of the GeoQuery.
void	onKeyMoved(java.lang.String documentID, com.google.firebase.firestore.GeoPoint location) Called if a documentID moved within the search area.

Method Detail

onKeyEntered

void onKeyEntered(java.lang.String documentID,
                  com.google.firebase.firestore.GeoPoint location)

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

Parameters:

documentID - The documentID that entered the search area

location - The location for this documentID

onKeyExited

void onKeyExited(java.lang.String documentID)

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

Parameters:

documentID - The documentID that exited the search area

onKeyMoved

void onKeyMoved(java.lang.String documentID,
                com.google.firebase.firestore.GeoPoint location)

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

Parameters:

documentID - The documentID that moved within the search area

location - The location for this documentID

onGeoQueryReady

void onGeoQueryReady()

Called once all initial GeoFirestore 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(java.lang.Exception exception)

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

Parameters:

exception - The exception that occurred while retrieving the query