java.lang.Object | ||
↳ | com.google.android.gms.common.api.GoogleApi<com.google.android.gms.common.api.Api.ApiOptions.NoOptions> | |
↳ | com.google.android.gms.location.FusedLocationProviderClient |
The main entry point for interacting with the fused location provider.
Note: It's recommended to use Google Play services version 11.6.0 or higher, which includes bug fixes for this class.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | KEY_VERTICAL_ACCURACY | Key used for the Bundle extra in Location object holding a float indicating the
estimated vertical accuracy of the location, in meters. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Flushes any locations currently being batched and sends them to all registered
LocationListener s, LocationCallback s, and PendingIntent s. | |||||||||||
Returns the best most recent location currently available.
| |||||||||||
Returns the availability of location data.
| |||||||||||
Removes all location updates for the given pending intent.
| |||||||||||
Removes all location updates for the given location result listener.
| |||||||||||
Requests location updates with a callback on the specified Looper thread.
| |||||||||||
Requests location updates with a callback on the specified PendingIntent.
| |||||||||||
Sets the mock location to be used for the location provider.
| |||||||||||
Sets whether or not the location provider is in mock mode.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Key used for the Bundle extra in Location
object holding a float indicating the
estimated vertical accuracy of the location, in meters.
We define vertical accuracy at 68% confidence. Specifically, as 1-side of the 2-sided range
above and below the estimated altitude reported by getAltitude()
, within which
there is a 68% probability of finding the true altitude.
In the case where the underlying distribution is assumed Gaussian normal, this would be considered 1 standard deviation.
For example, if getAltitude()
returns 150, and this extra returns 20 then
there is a 68% probability of the true altitude being between 130 and 170 meters.
If you're targeting Android O+ devices you should use directly hasVerticalAccuracy()
and getVerticalAccuracyMeters()
.
Flushes any locations currently being batched and sends them to all registered LocationListener
s, LocationCallback
s, and PendingIntent
s. This call is only
useful when batching is specified using setMaxWaitTime(long)
, otherwise
locations are already delivered immediately when available.
When the returned Task
is complete, then you can assume that any pending batched
locations have already been delivered.
Returns | |
---|---|
Task<Void> |
Returns the best most recent location currently available.
If a location is not available, which should happen very rarely, null will be returned. The best accuracy available while respecting the location permissions will be returned.
This method provides a simplified way to get location. It is particularly well suited for applications that do not require an accurate location and that do not want to maintain extra logic for location updates.
Returns | |
---|---|
Task<Location> |
Returns the availability of location data. When isLocationAvailable()
returns true, then the location returned by getLastLocation()
will be reasonably up to date within the hints specified by the active LocationRequest
s.
If the client isn't connected to Google Play services and the request times out, null is returned.
Note it's always possible for getLastLocation()
to return null even when this method
returns true (e.g. location settings were disabled between calls).
Returns | |
---|---|
Task<LocationAvailability> |
Removes all location updates for the given pending intent.
It is possible for this call to cancel the PendingIntent under some circumstances.
Parameters | |
---|---|
callbackIntent |
PendingIntent : The PendingIntent that was used in requestLocationUpdates(LocationRequest, PendingIntent) or is equal as defined by equals(Object) . |
Returns | |
---|---|
Task<Void> |
a Task for the call, check isSuccessful() to determine if it was
successful.
|
Removes all location updates for the given location result listener.
Parameters | |
---|---|
callback |
LocationCallback : The callback to remove. |
Returns | |
---|---|
Task<Void> |
a Task for the call, check isSuccessful() to determine if it was
successful.
|
Requests location updates with a callback on the specified Looper thread.
This method is suited for the foreground use cases. For background use cases, the PendingIntent
version of the method is recommended, see requestLocationUpdates(LocationRequest, PendingIntent)
.
Any previous LocationRequests registered on this LocationListener will be replaced.
This call will keep the Google Play services connection active, so make sure to call removeLocationUpdates(LocationCallback)
when you no longer need it, otherwise you lose the
benefits of the automatic connection management.
Callbacks for LocationCallback
will be made on the specified thread, which must
already be a prepared looper thread.
Parameters | |
---|---|
request |
LocationRequest : The location request for the updates. |
callback |
LocationCallback : The callback for the location updates. |
looper |
Looper : The Looper object whose message queue will be used to implement the callback
mechanism, or null to make callbacks on the calling thread. |
Returns | |
---|---|
Task<Void> |
a Task for the call, check isSuccessful() to determine if it was
successful. |
Throws | |
---|---|
IllegalStateException |
If looper is null and this method is executed in a thread that has not called Looper.prepare(). |
Requests location updates with a callback on the specified PendingIntent.
This method is suited for the background use cases, more specifically for receiving location
updates, even when the app has been killed by the system. In order to do so, use a PendingIntent
for a started service. For foreground use cases, the LocationCallback
version of the method is recommended, see requestLocationUpdates(LocationRequest, LocationCallback, Looper)
.
Any previously registered requests that have the same PendingIntent (as defined by equals(Object)
) will be replaced by this request.
Both LocationResult
and LocationAvailability
are sent to the given
PendingIntent. You can extract data from an Intent using hasResult(Intent)
,
extractResult(Intent)
, hasLocationAvailability(Intent)
, and
extractLocationAvailability(Intent)
.
Parameters | |
---|---|
request |
LocationRequest : The location request for the updates. |
callbackIntent |
PendingIntent : A pending intent to be sent for each location update. |
Returns | |
---|---|
Task<Void> |
a Task for the call, check isSuccessful() to determine if it was
successful.
|
Sets the mock location to be used for the location provider. This location will be used in place of any actual locations from the underlying providers (network or gps).
setMockMode(boolean)
must be called and set to true prior to calling this method.
Care should be taken in specifying the timestamps as many applications require them to be monotonically increasing.
Parameters | |
---|---|
mockLocation |
Location : The mock location. Must have a minimum number of fields set to be
considered a valild location, as per documentation in the Location class. |
Returns | |
---|---|
Task<Void> |
a Task for the call, check isSuccessful() to determine if it was
successful.
|
Throws | |
---|---|
SecurityException |
if the ACCESS_MOCK_LOCATION permission is not present or the Settings.Secure.ALLOW_MOCK_LOCATION
system setting is not enabled. |
Sets whether or not the location provider is in mock mode.
The underlying providers (network and gps) will be stopped (except by direct LocationManager
access), and only locations specified in setMockLocation(Location)
will be reported. This will effect all location clients connected using the
FusedLocationProviderApi
, including geofencer clients (i.e. geofences can be triggered
based on mock locations).
The client must remain connected in order for mock mode to remain active. If the client dies the system will return to its normal state.
Calls are not nested, and mock mode will be set directly regardless of previous calls.
Parameters | |
---|---|
isMockMode |
boolean : If true the location provider will be set to mock mode. If false it will be
returned to its normal state. |
Returns | |
---|---|
Task<Void> |
a Task for the call, check isSuccessful() to determine if it was
successful.
|
Throws | |
---|---|
SecurityException |
if the ACCESS_MOCK_LOCATION permission is not present or the Settings.Secure.ALLOW_MOCK_LOCATION
system setting is not enabled. |