ReactiveLocationProvider (android-reactive-location 0.10 API)

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)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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>`	`checkLocationSettings(LocationSettingsRequest locationRequest)` Observable that can be used to check settings state for given location request.
`static <T extends Result> <any>`	`fromPendingResult(<any> result)` Util method that wraps `com.google.android.gms.common.api.PendingResult` in Observable.
`<any>`	`getCurrentPlace(PlaceFilter placeFilter)` Returns observable that fetches current place from Places API.
`<any>`	`getDetectedActivity(int detectIntervalMiliseconds)` Observable that can be used to observe activity provided by Actity Recognition mechanism.
`<any>`	`getGeocodeObservable(java.lang.String locationName, int maxResults)` Creates observable that translates a street address or other description into a list of possible addresses using included Geocoder class.
`<any>`	`getGeocodeObservable(java.lang.String locationName, int maxResults, LatLngBounds bounds)` Creates observable that translates a street address or other description into a list of possible addresses using included Geocoder class.
`<any>`	`getGoogleApiClientObservable(Api... apis)` Observable that emits `com.google.android.gms.common.api.GoogleApiClient` object after connection.
`<any>`	`getLastKnownLocation()` Creates observable that obtains last known location and than completes.
`<any>`	`getPhotoForMetadata(PlacePhotoMetadata placePhotoMetadata)` Returns observable that fetches a placePhotoMetadata from the Places API using the place placePhotoMetadata metadata.
`<any>`	`getPhotoMetadataById(java.lang.String placeId)` Returns observable that fetches photo metadata from the Places API using the place ID.
`<any>`	`getPlaceAutocompletePredictions(java.lang.String query, LatLngBounds bounds, AutocompleteFilter filter)` Returns observable that fetches autocomplete predictions from Places API.
`<any>`	`getPlaceById(java.lang.String placeId)` Returns observable that fetches a place from the Places API using the place ID.
`<any>`	`getReverseGeocodeObservable(double lat, double lng, int maxResults)` Creates observable that translates latitude and longitude to list of possible addresses using included Geocoder class.
`<any>`	`getReverseGeocodeObservable(java.util.Locale locale, double lat, double lng, int maxResults)` Creates observable that translates latitude and longitude to list of possible addresses using included Geocoder class.
`<any>`	`getUpdatedLocation(LocationRequest locationRequest)` Creates observable that allows to observe infinite stream of location updates.
`<any>`	`mockLocation(<any> sourceLocationObservable)` Returns an observable which activates mock location mode when subscribed to, using the supplied observable as a source of mock locations.
`<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.
`<any>`	`removeLocationUpdates(android.app.PendingIntent intent)` Observable that can be used to remove `PendingIntent` location updates.
`<any>`	`requestLocationUpdates(LocationRequest locationRequest, android.app.PendingIntent intent)` Creates an observable that adds a `PendingIntent` as a location listener.

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 is never null - when it is unavailable Observable completes without emitting any value.
    Observable can report GoogleAPIConnectionException 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 GoogleAPIConnectionException 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
  - mockLocation
```
public <any> mockLocation(<any> sourceLocationObservable)
```
    Returns an observable which activates mock location mode when subscribed to, using the supplied observable as a source of mock locations. Mock locations will replace normal location information for all users of the FusedLocationProvider API on the device while this observable is subscribed to.
    To use this method, mock locations must be enabled in developer options and your application must hold the android.permission.ACCESS_MOCK_LOCATION permission, or a SecurityException will be thrown.
    All statuses that are not successful will be reported as StatusException.
    Every exception is delivered by rx.Observer#onError(Throwable).
    
    Parameters:
    
    sourceLocationObservable - observable that emits Location instances suitable to use as mock locations
    
    Returns:
    
    observable that emits com.google.android.gms.common.api.Status
  - requestLocationUpdates
```
public <any> requestLocationUpdates(LocationRequest locationRequest,
                                    android.app.PendingIntent intent)
```
    Creates an observable that adds a PendingIntent as a location listener.
    This invokes com.google.android.gms.location.FusedLocationProviderApi#requestLocationUpdates(com.google.android.gms.common.api.GoogleApiClient, com.google.android.gms.location.LocationRequest, android.app.PendingIntent).
    When location updates are no longer required, a call to removeLocationUpdates(android.app.PendingIntent) should be made.
    In case of unsuccessful status StatusException is delivered.
    
    Parameters:
    
    locationRequest - request object with info about what kind of location you need
    
    intent - PendingIntent that will be called with location updates
    
    Returns:
    
    observable that adds the request and PendingIntent
  - removeLocationUpdates
```
public <any> removeLocationUpdates(android.app.PendingIntent intent)
```
    Observable that can be used to remove PendingIntent location updates.
    In case of unsuccessful status StatusException is delivered.
    
    Parameters:
    
    intent - PendingIntent to remove location updates for
    
    Returns:
    
    observable that removes the PendingIntent
  - getReverseGeocodeObservable
```
public <any> getReverseGeocodeObservable(double lat,
                                         double lng,
                                         int maxResults)
```
    Creates observable that translates latitude and longitude to list of possible addresses using included Geocoder class. In case geocoder fails with IOException("Service not Available") fallback decoder is used using google web api. 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
  - getReverseGeocodeObservable
```
public <any> getReverseGeocodeObservable(java.util.Locale locale,
                                         double lat,
                                         double lng,
                                         int maxResults)
```
    Creates observable that translates latitude and longitude to list of possible addresses using included Geocoder class. In case geocoder fails with IOException("Service not Available") fallback decoder is used using google web api. You should subscribe for this observable on I/O thread. The stream finishes after address list is available.
    
    Parameters:
    
    locale - locale for address language
    
    lat - latitude
    
    lng - longitude
    
    maxResults - maximal number of results you are interested in
    
    Returns:
    
    observable that serves list of address based on location
  - getGeocodeObservable
```
public <any> getGeocodeObservable(java.lang.String locationName,
                                  int maxResults)
```
    Creates observable that translates a street address or other description into a 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:
    
    locationName - a user-supplied description of a location
    
    maxResults - max number of results you are interested in
    
    Returns:
    
    observable that serves list of address based on location name
  - getGeocodeObservable
```
public <any> getGeocodeObservable(java.lang.String locationName,
                                  int maxResults,
                                  LatLngBounds bounds)
```
    Creates observable that translates a street address or other description into a 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.
    You may specify a bounding box for the search results.
    
    Parameters:
    
    locationName - a user-supplied description of a location
    
    maxResults - max number of results you are interested in
    
    bounds - restricts the results to geographical bounds. May be null
    
    Returns:
    
    observable that serves list of address based on location name
  - 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 GoogleAPIConnectionException when there are trouble connecting with Google Play Services.
    In case of unsuccessful status StatusException is delivered.
    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)
    
    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.
    In case of unsuccessful status StatusException is delivered.
    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.
    In case of unsuccessful status StatusException is delivered.
    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
  - checkLocationSettings
```
public <any> checkLocationSettings(LocationSettingsRequest locationRequest)
```
    Observable that can be used to check settings state for given location request.
    
    Parameters:
    
    locationRequest - location request
    
    Returns:
    
    observable that emits check result of location settings
    
    See Also:
    
    com.google.android.gms.location.SettingsApi
  - getCurrentPlace
```
public <any> getCurrentPlace(PlaceFilter placeFilter)
```
    Returns observable that fetches current place from Places API. To flatmap and auto release buffer to com.google.android.gms.location.places.PlaceLikelihood observable use DataBufferObservable.
    
    Parameters:
    
    placeFilter - filter
    
    Returns:
    
    observable that emits current places buffer and completes
  - getPlaceById
```
public <any> getPlaceById(java.lang.String placeId)
```
    Returns observable that fetches a place from the Places API using the place ID.
    
    Parameters:
    
    placeId - id for place
    
    Returns:
    
    observable that emits places buffer and completes
  - getPlaceAutocompletePredictions
```
public <any> getPlaceAutocompletePredictions(java.lang.String query,
                                             LatLngBounds bounds,
                                             AutocompleteFilter filter)
```
    Returns observable that fetches autocomplete predictions from Places API. To flatmap and autorelease com.google.android.gms.location.places.AutocompletePredictionBuffer you can use DataBufferObservable.
    
    Parameters:
    
    query - search query
    
    bounds - bounds where to fetch suggestions from
    
    filter - filter
    
    Returns:
    
    observable with suggestions buffer and completes
  - getPhotoMetadataById
```
public <any> getPhotoMetadataById(java.lang.String placeId)
```
    Returns observable that fetches photo metadata from the Places API using the place ID.
    
    Parameters:
    
    placeId - id for place
    
    Returns:
    
    observable that emits metadata buffer and completes
  - getPhotoForMetadata
```
public <any> getPhotoForMetadata(PlacePhotoMetadata placePhotoMetadata)
```
    Returns observable that fetches a placePhotoMetadata from the Places API using the place placePhotoMetadata metadata. Use after fetching the place placePhotoMetadata metadata with getPhotoMetadataById(String)
    
    Parameters:
    
    placePhotoMetadata - the place photo meta data
    
    Returns:
    
    observable that emits the photo result and completes
  - getGoogleApiClientObservable
```
public <any> getGoogleApiClientObservable(Api... apis)
```
    Observable that emits com.google.android.gms.common.api.GoogleApiClient object after connection. In case of error GoogleAPIConnectionException is emmited. When connection to Google Play Services is suspended GoogleAPIConnectionSuspendedException is emitted as error. Do not disconnect from apis client manually - just unsubscribe.
    
    Parameters:
    
    apis - collection of apis to connect to
    
    Returns:
    
    observable that emits apis client after successful connection
  - fromPendingResult
```
public static <T extends Result> <any> fromPendingResult(<any> result)
```
    Util method that wraps com.google.android.gms.common.api.PendingResult in Observable.
    
    Type Parameters:
    
    T - parameter type of result
    
    Parameters:
    
    result - pending result to wrap
    
    Returns:
    
    observable that emits pending result and completes

Class ReactiveLocationProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReactiveLocationProvider

Method Detail

getLastKnownLocation

getUpdatedLocation

mockLocation

requestLocationUpdates

removeLocationUpdates

getReverseGeocodeObservable

getReverseGeocodeObservable

getGeocodeObservable

getGeocodeObservable

addGeofences

removeGeofences

removeGeofences

getDetectedActivity

checkLocationSettings

getCurrentPlace

getPlaceById

getPlaceAutocompletePredictions

getPhotoMetadataById

getPhotoForMetadata

getGoogleApiClientObservable

fromPendingResult