Add clarifications to CDM javadoc

- clarify modes of operations for different wireless transports
- add recommendation to use RPA in order to use the feature

Fixes: 183984032
Test: proofread

Change-Id: I7dc305890df5979278e198a25981a4876074082f
This commit is contained in:
Eugene Susla
2021-04-07 10:08:59 -07:00
parent 6c84cf58d9
commit e92753df23

View File

@@ -375,6 +375,14 @@ public final class CompanionDeviceManager {
* Calling app must check for feature presence of
* {@link PackageManager#FEATURE_COMPANION_DEVICE_SETUP} before calling this API.
*
* For Bluetooth LE devices this is based on scanning for device with the given address.
* For Bluetooth classic devices this is triggered when the device connects/disconnects.
* WiFi devices are not supported.
*
* If a Bluetooth LE device wants to use a rotating mac address, it is recommended to use
* Resolvable Private Address, and ensure the device is bonded to the phone so that android OS
* is able to resolve the address.
*
* @param deviceAddress a previously-associated companion device's address
*
* @throws DeviceNotAssociatedException if the given device was not previously associated