diff options
| author | 2024-07-15 20:26:53 +0000 | |
|---|---|---|
| committer | 2024-07-16 18:32:47 +0000 | |
| commit | 6607d54525f0f2137048c5799ad303820eae71e8 (patch) | |
| tree | 31ba5f2f0a09f63ef5f97e236a0b70a71c2b658d | |
| parent | 5247cd03f2f78929863cd4f7f5c911615262067a (diff) | |
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
| -rw-r--r-- | core/java/android/companion/CompanionDeviceManager.java | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/core/java/android/companion/CompanionDeviceManager.java b/core/java/android/companion/CompanionDeviceManager.java index 34cfa584b683..15298423e1ba 100644 --- a/core/java/android/companion/CompanionDeviceManager.java +++ b/core/java/android/companion/CompanionDeviceManager.java @@ -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 */ |