Share via


LocationRequest.MaxUpdateDelayMillis Property

Definition

Returns the maximum time any location update may be delayed, and thus grouped with following updates to enable location batching.

public long MaxUpdateDelayMillis { [Android.Runtime.Register("getMaxUpdateDelayMillis", "()J", "", ApiSince=31)] get; }
[<get: Android.Runtime.Register("getMaxUpdateDelayMillis", "()J", "", ApiSince=31)>]
member this.MaxUpdateDelayMillis : int64

Property Value

the maximum time by which a location update may be delayed

Attributes

Remarks

Returns the maximum time any location update may be delayed, and thus grouped with following updates to enable location batching. If the maximum update delay is equal to or greater than twice the interval, then location providers may provide batched results. The maximum batch size is the maximum update delay divided by the interval. Not all devices or location providers support batching, and use of this parameter does not guarantee that the client will see batched results, or that batched results will always be of the maximum size.

When available, batching can provide substantial power savings to the device, and clients are encouraged to take advantage where appropriate for the use case.

Java documentation for android.location.LocationRequest.getMaxUpdateDelayMillis().

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to