summaryrefslogtreecommitdiff
path: root/framework/java/android/bluetooth/le/ScanSettings.java
diff options
context:
space:
mode:
authorWei Wang <weiwa@google.com>2014-08-15 13:25:30 -0700
committerWei Wang <weiwa@google.com>2014-08-15 14:07:14 -0700
commit8a13e00e9ce93bd136c3b684f25b15541dda76aa (patch)
treeb643fdff72d356b74cbbc255bf0b25317d0b70aa /framework/java/android/bluetooth/le/ScanSettings.java
parent90b13ed753cec24dcb754267741f820cfcd2a438 (diff)
Fix API council review comments. Also hide certain APIs(1/3).
b/17006825. Change-Id: Iee64b11920152e0ab3da54decf37fa4a83be5dc7
Diffstat (limited to 'framework/java/android/bluetooth/le/ScanSettings.java')
-rw-r--r--framework/java/android/bluetooth/le/ScanSettings.java24
1 files changed, 16 insertions, 8 deletions
diff --git a/framework/java/android/bluetooth/le/ScanSettings.java b/framework/java/android/bluetooth/le/ScanSettings.java
index b2ee6a82c9..7eae4398e5 100644
--- a/framework/java/android/bluetooth/le/ScanSettings.java
+++ b/framework/java/android/bluetooth/le/ScanSettings.java
@@ -52,19 +52,28 @@ public final class ScanSettings implements Parcelable {
/**
* A result callback is only triggered for the first advertisement packet received that matches
* the filter criteria.
+ *
+ * @hide
*/
+ @SystemApi
public static final int CALLBACK_TYPE_FIRST_MATCH = 2;
/**
* Receive a callback when advertisements are no longer received from a device that has been
* previously reported by a first match callback.
+ *
+ * @hide
*/
+ @SystemApi
public static final int CALLBACK_TYPE_MATCH_LOST = 4;
/**
* Request full scan results which contain the device, rssi, advertising data, scan response as
* well as the scan timestamp.
+ *
+ * @hide
*/
+ @SystemApi
public static final int SCAN_RESULT_TYPE_FULL = 0;
/**
@@ -137,9 +146,6 @@ public final class ScanSettings implements Parcelable {
return 0;
}
- /**
- * @hide
- */
public static final Parcelable.Creator<ScanSettings>
CREATOR = new Creator<ScanSettings>() {
@Override
@@ -183,7 +189,9 @@ public final class ScanSettings implements Parcelable {
*
* @param callbackType The callback type flags for the scan.
* @throws IllegalArgumentException If the {@code callbackType} is invalid.
+ * @hide
*/
+ @SystemApi
public Builder setCallbackType(int callbackType) {
if (!isValidCallbackType(callbackType)) {
@@ -226,14 +234,14 @@ public final class ScanSettings implements Parcelable {
/**
* Set report delay timestamp for Bluetooth LE scan.
*
- * @param reportDelayMillis Set to 0 to be notified of results immediately. Values &gt; 0
- * causes the scan results to be queued up and delivered after the requested
- * delay or when the internal buffers fill up.
+ * @param reportDelayMillis Delay of report in milliseconds. Set to 0 to be notified of
+ * results immediately. Values &gt; 0 causes the scan results to be queued up and
+ * delivered after the requested delay or when the internal buffers fill up.
* @throws IllegalArgumentException If {@code reportDelayMillis} &lt; 0.
*/
- public Builder setReportDelayMillis(long reportDelayMillis) {
+ public Builder setReportDelay(long reportDelayMillis) {
if (reportDelayMillis < 0) {
- throw new IllegalArgumentException("reportDelayMillis must be > 0");
+ throw new IllegalArgumentException("reportDelay must be > 0");
}
mReportDelayMillis = reportDelayMillis;
return this;