summaryrefslogtreecommitdiff
path: root/framework/java/android/bluetooth/le/BluetoothLeScanner.java
diff options
context:
space:
mode:
authorAmith Yamasani <yamasani@google.com>2017-06-21 14:06:44 -0700
committerAmith Yamasani <yamasani@google.com>2017-06-21 14:06:44 -0700
commitcb75a93a765813ba3a0b87204a37944592c352ab (patch)
tree009eeb2ec7761baec2e23799a94d08357cc4dfe6 /framework/java/android/bluetooth/le/BluetoothLeScanner.java
parent6f696471c3f9324c9f0ffef484a9b742ce3e28a3 (diff)
Clarify startScan API on how to get results
Make it clear in BluetoothLeScanner on how to get results when starting a scan for a PendingIntent. Bug: 38365430 Test: make offline-sdk-docs Change-Id: I0bf88d751c89a8a478db985713357e153ac08595
Diffstat (limited to 'framework/java/android/bluetooth/le/BluetoothLeScanner.java')
-rw-r--r--framework/java/android/bluetooth/le/BluetoothLeScanner.java5
1 files changed, 5 insertions, 0 deletions
diff --git a/framework/java/android/bluetooth/le/BluetoothLeScanner.java b/framework/java/android/bluetooth/le/BluetoothLeScanner.java
index f3f0ae5cd9..1eac395bd0 100644
--- a/framework/java/android/bluetooth/le/BluetoothLeScanner.java
+++ b/framework/java/android/bluetooth/le/BluetoothLeScanner.java
@@ -136,6 +136,11 @@ public final class BluetoothLeScanner {
* Start Bluetooth LE scan using a {@link PendingIntent}. The scan results will be delivered via
* the PendingIntent. Use this method of scanning if your process is not always running and it
* should be started when scan results are available.
+ * <p>
+ * When the PendingIntent is delivered, the Intent passed to the receiver or activity
+ * will contain one or more of the extras {@link #EXTRA_CALLBACK_TYPE},
+ * {@link #EXTRA_ERROR_CODE} and {@link #EXTRA_LIST_SCAN_RESULT} to indicate the result of
+ * the scan.
*
* @param filters Optional list of ScanFilters for finding exact BLE devices.
* @param settings Optional settings for the scan.