Builder
class Builder
| kotlin.Any | |
| ↳ | android.ranging.oob.DeviceHandle.Builder |
Builder class for creating instances of DeviceHandle.
Summary
| Public constructors | |
|---|---|
Builder(rangingDevice: RangingDevice, transportHandle: TransportHandle)Constructs a new |
|
| Public methods | |
|---|---|
| DeviceHandle |
build()Builds and returns a new |
| DeviceHandle.Builder |
setBluetoothDevice(bluetoothDevice: BluetoothDevice)Sets the |
Public constructors
Builder
Builder(
rangingDevice: RangingDevice,
transportHandle: TransportHandle)
Constructs a new Builder with the required RangingDevice and TransportHandle.
| Parameters | |
|---|---|
rangingDevice |
RangingDevice: the RangingDevice This value cannot be null. |
transportHandle |
TransportHandle: Implementation of TransportHandle for sending/receiving OOB data from peer. This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
if either parameter is null. |
Public methods
build
fun build(): DeviceHandle
Builds and returns a new DeviceHandle instance using the parameters provided to this builder.
| Return | |
|---|---|
DeviceHandle |
a newly created DeviceHandle instance. This value cannot be null. |
setBluetoothDevice
fun setBluetoothDevice(bluetoothDevice: BluetoothDevice): DeviceHandle.Builder
Sets the BluetoothDevice associated with the target device. If this is set, the underlying ranging service will use the bluetooth device as the target for BLE RSSI and Channel Sounding ranging.
| Parameters | |
|---|---|
bluetoothDevice |
BluetoothDevice: the BluetoothDevice This value cannot be null. |
| Return | |
|---|---|
DeviceHandle.Builder |
the same DeviceHandle.Builder instance. This value cannot be null. |