LocationRequest

Create a location request with default parameters (PRIORITY_BALANCED_POWER_ACCURACY and a slowly updated location). Clients may further set parameters before using this location request.

Get the request expiration time, in elapsed realtime.

Get the fastest interval of this request, in milliseconds.

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 returned instead.

Get the number of updates requested.

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

Get the priority 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 location request will automatically be removed at some point after the duration expires. The duration starts when a location request is made, and includes suspend time. Values less than 0 are allowed, but indicate that the request has already expired.

Set the request expiration time, in elapsed realtime. The location request will automatically be remove at some point after the expiration time. Values before SystemClock.elapsedRealtime() are allowed, but indicate that the request has already expired.

Set the fastest interval in milliseconds for location updates to an explicit value.

This controls the absolute fastest rate at which a client can receive location updates. Clients can receive locations faster than their desired interval, and this parameter controls the absolute fastest allowed deliver rate. This allows clients to passively acquire locations at a rate faster than their interval.

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 as this may cause a client to use more power than desired.

Set the desired interval for location updates, in milliseconds.

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

You may receive updates faster or slower than the desired interval, or not at all (if location is off for example). The fastest rate that that you will receive updates can be controlled via setFastestInterval(long). By default the fastest rate is 6x the interval.

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

Sets the maximum wait time in milliseconds for location updates.

If you pass a value at least 2x larger than the interval specified via setInterval(long), then location delivery may be delayed by up to the maximum wait time so that batches of locations can be delivered at once. Locations are still calculated at the rate set by setInterval(long), but can be delivered in batches in order to consume less battery. If clients do not require immediate location delivery they should consider setting this value as large as reasonably possible.

FusedLocationProviderClient.flushLocations() may be used to flush locations that have been batched, but not delivered yet.

Set the number of location updates. After the location request has received this number of locations, it will be automatically removed. If this method is not called, a location request will continue to receive locations indefinitely until removed.

If you only need a single location update, prefer using FusedLocationProviderClient.getCurrentLocation(int, CancellationToken).

Consider also setting an explicit duration on a request, so that if locations cannot be derived for whatever reason, this location request does not continue to use power indefinitely.

Set the priority of the request to one of the priority constants in this class.

Set the minimum displacement between location updates in meters

By default this is 0.

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

Note that this only applies to clients with PRIORITY_HIGH_ACCURACY requests, and 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.