Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6607d545 authored by Raphael Kim's avatar Raphael Kim
Browse files

Update documentation for removeBond() API to clarify the independent... 

Update documentation for removeBond() API to clarify the independent relationship between bluetooth bonding and CDM association.

Bug: 346579155
Flag: DOCS_ONLY
Test: DOCS_ONLY
Change-Id: I700317aea1f5a55fc24a8c8d8058207a8fc6db06
parent 5247cd03

core/java/android/companion/CompanionDeviceManager.java

+6 −0
Original line number Diff line number Diff line
@@ -1172,6 +1172,12 @@ public final class CompanionDeviceManager { 
     * BluetoothDevice#ACTION_BOND_STATE_CHANGED} intents to be notified when the bond removal

     * process completes, and its result.

     *

     * <p>This API should be used to remove a bluetooth bond that was created either

     * by using {@link BluetoothDevice#createBond(int)} or by a direct user action.

     * The association must already exist with this device before calling this method, but

     * this may be done retroactively to remove a bond that was created outside of the

     * CompanionDeviceManager.

     *

     * @param associationId an already-associated companion device to remove bond from

     * @return false on immediate error, true if bond removal process will begin

     */