diff options
author | Stanley Tng <stng@google.com> | 2018-08-20 13:04:15 -0700 |
---|---|---|
committer | Stanley Tng <stng@google.com> | 2018-08-20 16:15:58 -0700 |
commit | 4ddfc18023ea4ec2dc0f190efda0387fe310ffdf (patch) | |
tree | e83f4a3a30cb6dd4a26ae7c3af2d9c99383859a9 /framework/java | |
parent | cd6875ef44dd3ddaf6ee2beaa8df31aafe9861be (diff) |
Add note for FLAG_CANCEL_CURRENT when stopping scan
Added a note in the Android API documentation for stopScan to make sure
that the flag FLAG_CANCEL_CURRENT is not used when creating the
PendingIntent parameter.
Bug: 77658091
Test: Just compile since not logic is changed
Change-Id: I55f33ae68679310ba4899708a2072a40fea0b3b4
Diffstat (limited to 'framework/java')
-rw-r--r-- | framework/java/android/bluetooth/le/BluetoothLeScanner.java | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/framework/java/android/bluetooth/le/BluetoothLeScanner.java b/framework/java/android/bluetooth/le/BluetoothLeScanner.java index a189e27137..a337a40094 100644 --- a/framework/java/android/bluetooth/le/BluetoothLeScanner.java +++ b/framework/java/android/bluetooth/le/BluetoothLeScanner.java @@ -275,7 +275,9 @@ public final class BluetoothLeScanner { } /** - * Stops an ongoing Bluetooth LE scan started using a PendingIntent. + * Stops an ongoing Bluetooth LE scan started using a PendingIntent. When creating the + * PendingIntent parameter, please do not use the FLAG_CANCEL_CURRENT flag. Otherwise, the stop + * scan may have no effect. * * @param callbackIntent The PendingIntent that was used to start the scan. * @see #startScan(List, ScanSettings, PendingIntent) |