pl.charmas.android.reactivelocation

Class ReactiveLocationProvider

java.lang.Object

pl.charmas.android.reactivelocation.ReactiveLocationProvider

public class ReactiveLocationProvider
extends java.lang.Object

Factory of observables that can manipulate location delivered by Google Play Services.

Constructor Summary

Constructors

Constructor and Description
ReactiveLocationProvider(android.content.Context ctx)

Method Summary

Modifier and Type	Method and Description
<any>	addGeofences(android.app.PendingIntent geofenceTransitionPendingIntent, GeofencingRequest request) Creates observable that adds request and completes when the action is done.
<any>	getDetectedActivity(int detectIntervalMiliseconds) Observable that can be used to observe activity provided by Actity Recognition mechanism.
<any>	getGeocodeObservable(double lat, double lng, int maxResults) Creates obserbable that translates latitude and longitude to list of possible addresses using included Geocoder class.
<any>	getLastKnownLocation() Creates observable that obtains last known location and than completes.
<any>	getUpdatedLocation(LocationRequest locationRequest) Creates observable that allows to observe infinite stream of location updates.
<any>	removeGeofences(java.util.List<java.lang.String> requestIds) Observable that can be used to remove geofences from LocationClient.
<any>	removeGeofences(android.app.PendingIntent pendingIntent) Observable that can be used to remove geofences from LocationClient.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReactiveLocationProvider

public ReactiveLocationProvider(android.content.Context ctx)

Method Detail

getLastKnownLocation

public <any> getLastKnownLocation()

Creates observable that obtains last known location and than completes. Delivered location can be null in some cases according to com.google.android.gms.location.FusedLocationProviderApi#getLastLocation(com.google.android.gms.common.api.GoogleApiClient) ()} docs.

Observable can report LocationConnectionException when there are trouble connecting with Google Play Services and other exceptions that can be thrown on com.google.android.gms.location.FusedLocationProviderApi#getLastLocation(com.google.android.gms.common.api.GoogleApiClient). Everything is delivered by rx.Observer#onError(Throwable).

Returns:

observable that serves last know location

getUpdatedLocation

public <any> getUpdatedLocation(LocationRequest locationRequest)

Creates observable that allows to observe infinite stream of location updates. To stop the stream you have to unsubscribe from observable - location updates are then disconnected.

Observable can report LocationConnectionException when there are trouble connecting with Google Play Services and other exceptions that can be thrown on com.google.android.gms.location.FusedLocationProviderApi#requestLocationUpdates(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.location.LocationRequest, com.google.android.gms.location.LocationListener). Everything is delivered by rx.Observer#onError(Throwable).

Parameters:

locationRequest - request object with info about what kind of location you need

Returns:

observable that serves infinite stream of location updates

getGeocodeObservable

public <any> getGeocodeObservable(double lat,
                                  double lng,
                                  int maxResults)

Creates obserbable that translates latitude and longitude to list of possible addresses using included Geocoder class. You should subscribe for this observable on I/O thread. The stream finishes after address list is available.

Parameters:

lat - latitude

lng - longitude

maxResults - maximal number of results you are interested in

Returns:

observable that serves list of address based on location

addGeofences

public <any> addGeofences(android.app.PendingIntent geofenceTransitionPendingIntent,
                          GeofencingRequest request)

Creates observable that adds request and completes when the action is done.

Observable can report LocationConnectionException when there are trouble connecting with Google Play Services.

The AddGeofenceException is reported only on com.google.android.gms.location.LocationStatusCodes#ERROR. Every other status is included in AddGeofenceResult.

Other exceptions will be reported that can be thrown on com.google.android.gms.location.GeofencingApi#addGeofences(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.location.GeofencingRequest, android.app.PendingIntent)

Every exception is delivered by rx.Observer#onError(Throwable).

Parameters:

geofenceTransitionPendingIntent - pending intent to register on geofence transition

request - list of request to add

Returns:

observable that adds request

removeGeofences

public <any> removeGeofences(android.app.PendingIntent pendingIntent)

Observable that can be used to remove geofences from LocationClient.

The RemoveGeofencesException is reported only on com.google.android.gms.location.LocationStatusCodes#ERROR. Every other status is included in RemoveGeofencesResult.

Other exceptions will be reported that can be thrown on com.google.android.gms.location.GeofencingApi#removeGeofences(com.google.android.gms.common.api.GoogleApiClient, android.app.PendingIntent).

Every exception is delivered by rx.Observer#onError(Throwable).

Parameters:

pendingIntent - key of registered geofences

Returns:

observable that removed geofences

removeGeofences

public <any> removeGeofences(java.util.List<java.lang.String> requestIds)

Observable that can be used to remove geofences from LocationClient.

The RemoveGeofencesException is reported only on com.google.android.gms.location.LocationStatusCodes#ERROR. Every other status is included in RemoveGeofencesResult.

Other exceptions will be reported that can be thrown on com.google.android.gms.location.GeofencingApi#removeGeofences(com.google.android.gms.common.api.GoogleApiClient, java.util.List).

Every exception is delivered by rx.Observer#onError(Throwable).

Parameters:

requestIds - geofences to remove

Returns:

observable that removed geofences

getDetectedActivity

public <any> getDetectedActivity(int detectIntervalMiliseconds)

Observable that can be used to observe activity provided by Actity Recognition mechanism.

Parameters:

detectIntervalMiliseconds - detecion interval

Returns:

observable that provides activity recognition