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

Commit 6d1acc06 authored by Christine Hallstrom's avatar Christine Hallstrom Committed by William Escande
Browse files

Update IRK scan documentation 

Provide further clarification on IRK scan API behavior based on feedback
in b/288319369#comment4.

Test: m Bluetooth | Updating documentation doesn't require a test
Bug: 288319369
Change-Id: I3475c1487c18e9d83fd2237522ac57c85e1e9231
parent ccc3bce6

framework/java/android/bluetooth/le/ScanFilter.java

+11 −2
Original line number Diff line number Diff line
@@ -779,12 +779,21 @@ public final class ScanFilter implements Parcelable { 
         * <p>The IRK is used to resolve a static address from a private address. The IRK must be

         * provided in little endian byte order.

         *

         * <p>Note if the device with this IRK is already bonded, calling {@link

         * <p>When using this API, it is recommended to continue scanning until the device is

         * bonded.

         *

         * <p>The resulting {@link ScanResult} that matches this filter will contain an {@link

         * BluetoothDevice} object for which the {@link BluetoothDevice#getAddress} method will

         * return the device address passed as a parameter in this method.

         *

         * <p>It is not recommended to use this API for discovering devices that are already bonded,

         * but note if the device with this IRK is already bonded, calling {@link

         * BluetoothDevice#getAddress} on the {@link ScanResult} using this filter will return the

         * device address that was used to initiate bonding, and may not match the address passed

         * into this method in that scenario.

         *

         * @param deviceAddress the remote device Bluetooth address for the filter

         * @param deviceAddress the remote device Bluetooth address for the filter in big endian

         *     order

         * @param addressType indication of the type of address

         * @param irk non-null little endian byte array representing the Identity Resolving Key

         * @throws IllegalArgumentException If the {@code deviceAddress} is invalid