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
This commit is contained in:
Stanley Tng
2018-08-20 13:04:15 -07:00
parent 36a9fa62be
commit 20fc9a250e

View File

@@ -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)