Skip to content

Document LocationRequest builder options #567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 3 commits into from
Aug 16, 2026
+86 −27
Merged

Document LocationRequest builder options #567

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f90d33c
Document location request builder options
jonathanpeppers Aug 15, 2026
4bb743d
Document fluent builder returns
jonathanpeppers Aug 15, 2026
4d2ed97
Correct location request constraints
jonathanpeppers Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 86 additions & 27 deletions docs/xml/Android.Locations/LocationRequest+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Clears an explicitly set minimum update interval and reverts to an implicit minimum update interval.</summary>
<returns>This builder.</returns>
<remarks>
Comment thread
jonathanpeppers marked this conversation as resolved.
<para>The implicit minimum update interval is a sensible default between zero and the request interval.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#clearMinUpdateIntervalMillis()" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.clearMinUpdateIntervalMillis()</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down Expand Up @@ -257,10 +265,18 @@
<Parameter Name="durationMillis" Type="System.Int64" />
</Parameters>
<Docs>
<param name="durationMillis">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="durationMillis">The duration, in milliseconds, before the request is automatically removed. The value must be at least 1.</param>
<summary>Sets the duration that this request continues before it is automatically removed.</summary>
<returns>This builder.</returns>
<remarks>
<para>Defaults to <c>long.MaxValue</c>, which represents an unlimited duration.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#setDurationMillis(long)" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.setDurationMillis(long)</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetIntervalMillis">
Expand Down Expand Up @@ -290,10 +306,19 @@
<Parameter Name="intervalMillis" Type="System.Int64" />
</Parameters>
<Docs>
<param name="intervalMillis">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="intervalMillis">The requested update interval, in milliseconds. The value must be non-negative.</param>
<summary>Sets the request interval.</summary>
<returns>This builder.</returns>
<remarks>
<para>Setting the interval to <see cref="F:Android.Locations.LocationRequest.PassiveInterval" /> prevents this request from actively generating location updates, while allowing it to receive updates generated by other requests. A passive request must have an explicit minimum update interval.</para>
<para>Locations can be available more frequently than this interval; use <see cref="M:Android.Locations.LocationRequest.Builder.SetMinUpdateIntervalMillis(System.Int64)" /> to control that behavior.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#setIntervalMillis(long)" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.setIntervalMillis(long)</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetMaxUpdateDelayMillis">
Expand Down Expand Up @@ -323,10 +348,18 @@
<Parameter Name="maxUpdateDelayMillis" Type="System.Int64" />
</Parameters>
<Docs>
<param name="maxUpdateDelayMillis">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="maxUpdateDelayMillis">The maximum delay, in milliseconds, before an update can be delivered in a batch. The value must be non-negative.</param>
<summary>Sets the maximum time an update can be delayed to enable location batching.</summary>
<returns>This builder.</returns>
<remarks>
<para>If the maximum update delay is at least twice the request interval, location providers can provide batched results. The default is zero, which disables batching.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#setMaxUpdateDelayMillis(long)" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.setMaxUpdateDelayMillis(long)</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetMaxUpdates">
Expand Down Expand Up @@ -356,10 +389,18 @@
<Parameter Name="maxUpdates" Type="System.Int32" />
</Parameters>
<Docs>
<param name="maxUpdates">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="maxUpdates">The maximum number of updates before the request is removed. The value must be at least 1.</param>
<summary>Sets the maximum number of location updates before this request is automatically removed.</summary>
<returns>This builder.</returns>
<remarks>
<para>The default is <c>int.MaxValue</c>, which represents an unlimited number of updates.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#setMaxUpdates(int)" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.setMaxUpdates(int)</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetMinUpdateDistanceMeters">
Expand Down Expand Up @@ -389,10 +430,19 @@
<Parameter Name="minUpdateDistanceMeters" Type="System.Single" />
</Parameters>
<Docs>
<param name="minUpdateDistanceMeters">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="minUpdateDistanceMeters">The minimum distance, in meters, between updates. The value must be finite and between 0.0f and <c>float.MaxValue</c> inclusive.</param>
<summary>Sets the minimum distance between location updates.</summary>
<returns>This builder.</returns>
<exception cref="T:Java.Lang.IllegalArgumentException">If <paramref name="minUpdateDistanceMeters" /> is <c>float.PositiveInfinity</c> or <c>float.NaN</c>.</exception>
<remarks>
<para>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.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#setMinUpdateDistanceMeters(float)" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.setMinUpdateDistanceMeters(float)</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetMinUpdateIntervalMillis">
Expand Down Expand Up @@ -422,10 +472,19 @@
<Parameter Name="minUpdateIntervalMillis" Type="System.Int64" />
</Parameters>
<Docs>
<param name="minUpdateIntervalMillis">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="minUpdateIntervalMillis">The minimum interval, in milliseconds, between updates. The value must be non-negative.</param>
<summary>Sets an explicit minimum update interval.</summary>
<returns>This builder.</returns>
<remarks>
<para>When updates are available more frequently than the request interval, this interval controls how frequently updates are delivered. Android allows a small amount of timing jitter, so an update can arrive slightly earlier than the specified interval. Without an explicit value, the system chooses a sensible default between zero and the request interval.</para>
<para>When <see cref="M:Android.Locations.LocationRequest.Builder.Build" /> is called, the smaller of the request interval and this value becomes the built request's minimum update interval.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/location/LocationRequest.Builder#setMinUpdateIntervalMillis(long)" title="Reference documentation">Java documentation for <code>android.location.LocationRequest.Builder.setMinUpdateIntervalMillis(long)</code>.</a></format></para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetQuality">
Expand Down