co.easimart.LocationCallback Maven / Gradle / Ivy
package co.easimart;
/**
* A {@code LocationCallback} is used to run code after a Location has been fetched by
* {@link EasimartGeoPoint#getCurrentLocationInBackground(long, android.location.Criteria)}.
*
* The easiest way to use a {@code LocationCallback} is through an anonymous inner class. Override the
* {@code done} function to specify what the callback should do after the location has been
* fetched. The {@code done} function will be run in the UI thread, while the location check
* happens in a background thread. This ensures that the UI does not freeze while the fetch happens.
*
* For example, this sample code defines a timeout for fetching the user's current location, and
* provides a callback. Within the callback, the success and failure cases are handled differently.
*
*
* EasimartGeoPoint.getCurrentLocationAsync(1000, new LocationCallback() {
* public void done(EasimartGeoPoint geoPoint, EasimartException e) {
* if (e == null) {
* // do something with your new EasimartGeoPoint
* } else {
* // handle your error
* e.printStackTrace();
* }
* }
* });
*
*/
public interface LocationCallback extends EasimartCallback2 {
/**
* Override this function with the code you want to run after the location fetch is complete.
*
* @param geoPoint
* The {@link EasimartGeoPoint} returned by the location fetch.
* @param e
* The exception raised by the location fetch, or {@code null} if it succeeded.
*/
@Override
public void done(EasimartGeoPoint geoPoint, EasimartException e);
}