Skip to content

Document Android ranging session APIs #603

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 17, 2026
+75 −14
Merged

Document Android ranging session APIs #603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2100e50
Document Android ranging session APIs
jonathanpeppers Aug 16, 2026
2bbb977
Address ranging documentation review
jonathanpeppers Aug 16, 2026
a2b0b76
Correct ranging API contracts
jonathanpeppers Aug 17, 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
71 changes: 59 additions & 12 deletions docs/xml/Android.Ranging/RangingManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,28 @@
<Parameter Name="callback" Type="Android.Ranging.RangingSession+ICallback" />
</Parameters>
<Docs>
<param name="executor">To be added.</param>
<param name="callback">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="executor">The executor on which the callback will be invoked.</param>
<param name="callback">The callback to receive session-related events.</param>
<summary>Creates a new ranging session.</summary>
<returns>A <c>RangingSession</c> that can initiate, manage, and stop ranging operations if
the session is successfully created; otherwise, <c>null</c>.</returns>
<remarks>
<para>Creates a new ranging session. A ranging session enables the application to perform
ranging operations using available technologies such as Ultra-Wideband (UWB) or Wi-Fi
Round Trip Time (RTT).</para>
<para>The callback receives session-related events, including session start, stop, and
ranging updates. Provide an executor that handles callbacks on a suitable thread.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/ranging/RangingManager#createRangingSession(java.util.concurrent.Executor,android.ranging.RangingSession.Callback)" title="Reference documentation">Java documentation for <code>android.ranging.RangingManager.createRangingSession(java.util.concurrent.Executor, android.ranging.RangingSession.Callback)</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 @@ -236,10 +253,25 @@
<Parameter Name="callback" Type="Android.Ranging.RangingManager+IRangingCapabilitiesCallback" />
</Parameters>
<Docs>
<param name="executor">To be added.</param>
<param name="callback">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="executor">The executor on which the callback will be invoked.</param>
<param name="callback">The callback that receives capabilities updates.</param>
<summary>Registers a callback to receive ranging capabilities updates.</summary>
<remarks>
<para>Registers a callback to receive ranging capabilities updates.</para>
<para>Callback events are dispatched through the provided executor, which controls the
thread on which they run. Use Context.getMainExecutor() to dispatch events on
the application's main thread, or provide an executor for another suitable thread.</para>
Comment thread
jonathanpeppers marked this conversation as resolved.
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/ranging/RangingManager#registerCapabilitiesCallback(java.util.concurrent.Executor,android.ranging.RangingManager.RangingCapabilitiesCallback)" title="Reference documentation">Java documentation for <code>android.ranging.RangingManager.registerCapabilitiesCallback(java.util.concurrent.Executor, android.ranging.RangingManager.RangingCapabilitiesCallback)</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="ThresholdClass">
Expand Down Expand Up @@ -327,9 +359,24 @@
<Parameter Name="callback" Type="Android.Ranging.RangingManager+IRangingCapabilitiesCallback" />
</Parameters>
<Docs>
<param name="callback">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="callback">The capabilities callback to unregister.</param>
<summary>Unregisters a previously registered ranging capabilities callback.</summary>
<remarks>
<para>Unregisters a previously registered ranging capabilities callback.</para>
<para>After it is unregistered, no further ranging capabilities updates are dispatched to
the callback. Callbacks that were already queued on the callback's executor, or are
already in progress, can still be delivered after this method returns.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/ranging/RangingManager#unregisterCapabilitiesCallback(android.ranging.RangingManager.RangingCapabilitiesCallback)" title="Reference documentation">Java documentation for <code>android.ranging.RangingManager.unregisterCapabilitiesCallback(android.ranging.RangingManager.RangingCapabilitiesCallback)</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="Uwb">
Expand Down
18 changes: 16 additions & 2 deletions docs/xml/Android.Ranging/RangingSession.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,22 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Closes this resource, relinquishing any underlying resources.</summary>
<remarks>
<para>Closes this resource, relinquishing any underlying resources.
This method is invoked automatically on objects managed by the
<c>try</c>-with-resources statement.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/ranging/RangingSession#close()" title="Reference documentation">Java documentation for <code>android.ranging.RangingSession.close()</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