StartBleScanRequest.Builder
Stay organized with collections
Save and categorize content based on your preferences.
Builder used to create new DataSourceRequests.
Public Constructor Summary
Inherited Method Summary
From class java.lang.Object
|
Object
|
clone()
|
| boolean |
|
| void |
finalize()
|
|
final Class<?>
|
getClass()
|
| int |
hashCode()
|
| final void |
notify()
|
| final void |
notifyAll()
|
|
String
|
toString()
|
| final void |
wait(long arg0, int arg1)
|
| final void |
wait(long arg0)
|
| final void |
wait()
|
Public Methods
Finishes building and returns the request.
Sets the callback to be used when devices are found. The callback must be set or
build() will throw an exception.
Parameters
| bleScanCallback |
The callback to be called. |
Sets the desired data types to search for on the BLE scan. We'll only return devices
which match this data type. If no data types are set, the request will return all
compatible devices.
Parameters
| dataTypes |
The data types to search for. These can be one of the data types listed in
DataType,
or a custom data type. |
Sets how long to wait before automatically stopping the scan, in seconds. If this
method isn't called scans will stop after 10 seconds by default.
Parameters
| stopTimeSecs |
Duration of the scan before stopping. Must be a value between 1 and 60
seconds. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eStartBleScanRequest.Builder\u003c/code\u003e is used to create requests for initiating Bluetooth Low Energy (BLE) scans for fitness data.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify desired data types to filter scanned devices and a callback to handle device discovery.\u003c/p\u003e\n"],["\u003cp\u003eThe scan duration can be customized, with a default of 10 seconds if not explicitly set.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method finalizes the request and returns a \u003ccode\u003eStartBleScanRequest\u003c/code\u003e object.\u003c/p\u003e\n"]]],[],null,["# StartBleScanRequest.Builder\n\npublic static class **StartBleScanRequest.Builder** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nBuilder used to create new DataSourceRequests. \n\n### Public Constructor Summary\n\n|---|--------------------------------------------------------------------------------------------------------------|\n| | [Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder#Builder())() |\n\n### Public Method Summary\n\n|----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [StartBleScanRequest](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest) | [build](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder#build())() Finishes building and returns the request. |\n| [StartBleScanRequest.Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder) | [setBleScanCallback](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder#setBleScanCallback(com.google.android.gms.fitness.request.BleScanCallback))([BleScanCallback](/android/reference/com/google/android/gms/fitness/request/BleScanCallback) bleScanCallback) Sets the callback to be used when devices are found. |\n| [StartBleScanRequest.Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder) | [setDataTypes](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder#setDataTypes(com.google.android.gms.fitness.data.DataType...))([DataType...](/android/reference/com/google/android/gms/fitness/data/DataType) dataTypes) Sets the desired data types to search for on the BLE scan. |\n| [StartBleScanRequest.Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder) | [setTimeoutSecs](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder#setTimeoutSecs(int))(int stopTimeSecs) Sets how long to wait before automatically stopping the scan, in seconds. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Constructors\n-------------------\n\n#### public **Builder** ()\n\nPublic Methods\n--------------\n\n#### public [StartBleScanRequest](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest)\n**build** ()\n\nFinishes building and returns the request. \n\n##### Throws\n\n| [IllegalStateException](//developer.android.com/reference/java/lang/IllegalStateException.html) | If the builder doesn't have enough data to build a valid request. |\n|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n\n#### public [StartBleScanRequest.Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder) **setBleScanCallback** ([BleScanCallback](/android/reference/com/google/android/gms/fitness/request/BleScanCallback) bleScanCallback)\n\nSets the callback to be used when devices are found. The callback must be set or\n[build()](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder#build()) will throw an exception. \n\n##### Parameters\n\n| bleScanCallback | The callback to be called. |\n|-----------------|----------------------------|\n\n#### public [StartBleScanRequest.Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder) **setDataTypes** ([DataType...](/android/reference/com/google/android/gms/fitness/data/DataType) dataTypes)\n\nSets the desired data types to search for on the BLE scan. We'll only return devices\nwhich match this data type. If no data types are set, the request will return all\ncompatible devices. \n\n##### Parameters\n\n| dataTypes | The data types to search for. These can be one of the data types listed in [DataType](/android/reference/com/google/android/gms/fitness/data/DataType), or a custom data type. |\n|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\n#### public [StartBleScanRequest.Builder](/android/reference/com/google/android/gms/fitness/request/StartBleScanRequest.Builder) **setTimeoutSecs** (int stopTimeSecs)\n\nSets how long to wait before automatically stopping the scan, in seconds. If this\nmethod isn't called scans will stop after 10 seconds by default. \n\n##### Parameters\n\n| stopTimeSecs | Duration of the scan before stopping. Must be a value between 1 and 60 seconds. |\n|--------------|---------------------------------------------------------------------------------|"]]