LocationRequest

Used with setPriority(int) to request "block" level accuracy.

Block level accuracy is considered to be about 100 meter accuracy. Using a coarse accuracy such as this often consumes less power.

Used with setPriority(int) to request the most accurate locations available.

This will return the finest location available.

Used with setPriority(int) to request "city" level accuracy.

City level accuracy is considered to be about 10km accuracy. Using a coarse accuracy such as this often consumes less power.

Used with setPriority(int) to request the best accuracy possible with zero additional power consumption.

No locations will be returned unless a different client has requested location updates in which case this request will act as a passive listener to those locations.

Create a location request with default parameters.

Default parameters are for a block accuracy, slowly updated location. It can then be adjusted as required by the applications before passing to the FusedLocationProviderClient.

Get the request expiration time, in milliseconds since boot.

This value can be compared to SystemClock.elapsedRealtime() to determine the time until expiration.

Get the fastest interval of this request, in milliseconds.

The system will never provide location updates faster than the minimum of getFastestInterval() and getInterval().

Get the desired interval of this request, in milliseconds.

Gets the maximum wait time in milliseconds for location updates. If the wait time is smaller than the interval requested with setInterval(long), then the interval will be used instead.

Get the number of updates requested.

By default this is Integer.MAX_VALUE, which indicates that locations are updated until the request is explicitly removed.

Get the quality of the request.

Get the minimum displacement between location updates in meters

By default this is 0.

Returns whether or not the fastest interval was explicitly specified for the location request.

Returns whether the location services will wait a few seconds initially for accurate locations, if accurate locations cannot be computed on the device for PRIORITY_HIGH_ACCURACY requests.

Set the duration of this request, in milliseconds.

The duration begins immediately (and not when the request is passed to the location client), so call this method again if the request is re-used at a later time.

The location client will automatically stop updates after the request expires.

The duration includes suspend time. Values less than 0 are allowed, but indicate that the request has already expired.

Set the request expiration time, in millisecond since boot.

This expiration time uses the same time base as SystemClock.elapsedRealtime().

The location client will automatically stop updates after the request expires.

The duration includes suspend time. Values before SystemClock.elapsedRealtime() are allowed, but indicate that the request has already expired.

Explicitly set the fastest interval for location updates, in milliseconds.

This controls the fastest rate at which your application will receive location updates, which might be faster than setInterval(long) in some situations (for example, if other applications are triggering location updates).

This allows your application to passively acquire locations at a rate faster than it actively acquires locations, saving power.

Unlike setInterval(long), this parameter is exact. Your application will never receive updates faster than this value.

If you don't call this method, a fastest interval will be selected for you. It will be a value faster than your active interval (setInterval(long)).

An interval of 0 is allowed, but not recommended, since location updates may be extremely fast on future implementations.

If setFastestInterval(long) is set slower than setInterval(long), then your effective fastest interval is setInterval(long).

Set the desired interval for active location updates, in milliseconds.

The location client will actively try to obtain location updates for your application at this interval, so it has a direct influence on the amount of power used by your application. Choose your interval wisely.

This interval is inexact. You may not receive updates at all (if no location sources are available), or you may receive them slower than requested. You may also receive them faster than requested (if other applications are requesting location at a faster interval). The fastest rate that that you will receive updates can be controlled with setFastestInterval(long). By default this fastest rate is 6x the interval frequency.

Applications with only the coarse location permission may have their interval silently throttled.

An interval of 0 is allowed, but not recommended, since location updates may be extremely fast on future implementations.

setPriority(int) and setInterval(long) are the most important parameters on a location request.

Sets the maximum wait time in milliseconds for location updates.

If you pass a value at least 2x larger than the interval specified with setInterval(long), then location delivery may be delayed and multiple locations can be delivered at once. Locations are determined at the setInterval(long) rate, but can be delivered in batch after the interval you set in this method. This can consume less battery and give more accurate locations, depending on the device's hardware capabilities. You should set this value to be as large as possible for your needs if you don't need immediate location delivery.

Set the number of location updates.

By default locations are continuously updated until the request is explicitly removed, however you can optionally request a set number of updates. For example, if your application only needs a single fresh location, then call this method with a value of 1 before passing the request to the location client.

When using this option care must be taken to either explicitly remove the request when no longer needed or to set an expiration with (setExpirationDuration(long) or setExpirationTime(long). Otherwise in some cases if a location can't be computed, this request could stay active indefinitely consuming power.

Set the priority of the request.

Use with a priority constant such as PRIORITY_HIGH_ACCURACY. No other values are accepted.

The priority of the request is a strong hint to the LocationClient for which location sources to use. For example, PRIORITY_HIGH_ACCURACY is more likely to use GPS, and PRIORITY_BALANCED_POWER_ACCURACY is more likely to use WIFI & Cell tower positioning, but it also depends on many other factors (such as which sources are available) and is implementation dependent.

setPriority(int) and setInterval(long) are the most important parameters on a location request.

Set the minimum displacement between location updates in meters

By default this is 0.

Sets whether the client wants the locations services to wait a few seconds for accurate locations initially, when accurate locations could not be computed on the device immediately after PRIORITY_HIGH_ACCURACY request is made. By default the location services will wait for accurate locations.

Note that this only applies to clients with PRIORITY_HIGH_ACCURACY requests.

Also note this only applies to the initial locations computed right after the location request is added. The following inaccurate locations may still be delivered to the clients without delay.