LocationRequest.Builder.SetMinUpdateDistanceMeters(Single) Method

Definition

Sets the minimum distance between location updates.

[Android.Runtime.Register("setMinUpdateDistanceMeters", "(F)Landroid/location/LocationRequest$Builder;", "", ApiSince=31)]
public Android.Locations.LocationRequest.Builder SetMinUpdateDistanceMeters(float minUpdateDistanceMeters);
[<Android.Runtime.Register("setMinUpdateDistanceMeters", "(F)Landroid/location/LocationRequest$Builder;", "", ApiSince=31)>]
member this.SetMinUpdateDistanceMeters : single -> Android.Locations.LocationRequest.Builder

Parameters

minUpdateDistanceMeters
Single

The minimum distance, in meters, between updates. The value must be finite and between 0.0f and float.MaxValue inclusive.

Returns

This builder.

Attributes

Exceptions

If minUpdateDistanceMeters is float.PositiveInfinity or float.NaN.

Remarks

A potential update that is closer to the preceding update than this distance is not delivered. The default is zero, which sets no minimum update distance.

Java documentation for android.location.LocationRequest.Builder.setMinUpdateDistanceMeters(float).

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