org.imperiumlabs.geofirestore

Interface GeoQueryDataEventListener

public interface GeoQueryDataEventListener

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

Method Summary

Modifier and Type	Method and Description
void	onDocumentChanged(com.google.firebase.firestore.DocumentSnapshot documentSnapshot, com.google.firebase.firestore.GeoPoint location) Called if a document changed within the search area.
void	onDocumentEntered(com.google.firebase.firestore.DocumentSnapshot documentSnapshot, com.google.firebase.firestore.GeoPoint location) Called if a document entered the search area of the GeoQuery.
void	onDocumentExited(com.google.firebase.firestore.DocumentSnapshot documentSnapshot) Called if a document exited the search area of the GeoQuery.
void	onDocumentMoved(com.google.firebase.firestore.DocumentSnapshot documentSnapshot, com.google.firebase.firestore.GeoPoint location) Called if a document moved within the search area.
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.

Method Detail

onDocumentEntered

void onDocumentEntered(com.google.firebase.firestore.DocumentSnapshot documentSnapshot,
                       com.google.firebase.firestore.GeoPoint location)

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

Parameters:

documentSnapshot - The snapshot of the associated document that entered the search area

location - The location for this document

onDocumentExited

void onDocumentExited(com.google.firebase.firestore.DocumentSnapshot documentSnapshot)

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

Parameters:

documentSnapshot - The snapshot of the associated document that exited the search area

onDocumentMoved

void onDocumentMoved(com.google.firebase.firestore.DocumentSnapshot documentSnapshot,
                     com.google.firebase.firestore.GeoPoint location)

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

Parameters:

documentSnapshot - The snapshot of the associated document that moved within the search area

location - The location for this document

onDocumentChanged

void onDocumentChanged(com.google.firebase.firestore.DocumentSnapshot documentSnapshot,
                       com.google.firebase.firestore.GeoPoint location)

Called if a document changed within the search area. An onDocumentMoved() is always followed by onDocumentChanged() but it is be possible to see onDocumentChanged() without an preceding onDocumentMoved(). This method can be called multiple times for a single location change, due to the way Firestore handles floating point numbers.

Parameters:

documentSnapshot - The snapshot of the associated document that moved within the search area

location - The location for this document

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 document entered or document 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