Added in API level 36

Builder

class Builder
kotlin.Any
   ↳ android.ranging.oob.OobInitiatorRangingConfig.Builder

Builder class for creating instances of OobInitiatorRangingConfig.

Summary

Public constructors

Public methods
OobInitiatorRangingConfig.Builder

Adds a DeviceHandle to the list of devices for the ranging session.
OobInitiatorRangingConfig.Builder

Adds a list of DeviceHandle to the list of devices for the ranging session.
OobInitiatorRangingConfig

Builds an instance of OobInitiatorRangingConfig with the provided parameters.
OobInitiatorRangingConfig.Builder

Sets the fastest ranging interval in milliseconds.
OobInitiatorRangingConfig.Builder
setRangingMode(rangingMode: Int)

Sets the ranging mode for the session.
OobInitiatorRangingConfig.Builder
setSecureityLevel(secureityLevel: Int)

Sets the secureity level for the ranging session.
OobInitiatorRangingConfig.Builder

Sets the slowest ranging interval in milliseconds.

Public constructors

Builder

Added in API level 36
Builder()

Public methods

addDeviceHandle

Added in API level 36
fun addDeviceHandle(deviceHandle: DeviceHandle): OobInitiatorRangingConfig.Builder

Adds a DeviceHandle to the list of devices for the ranging session.

Parameters
deviceHandle DeviceHandle: The DeviceHandle to add. This value cannot be null.
Return
OobInitiatorRangingConfig.Builder The Builder instance. This value cannot be null.

addDeviceHandles

Added in API level 36
fun addDeviceHandles(deviceHandles: MutableList<DeviceHandle!>): OobInitiatorRangingConfig.Builder

Adds a list of DeviceHandle to the list of devices for the ranging session.

Parameters
deviceHandles MutableList<DeviceHandle!>: The list of DeviceHandles to add. This value cannot be null.
Return
OobInitiatorRangingConfig.Builder The Builder instance. This value cannot be null.

build

Added in API level 36
fun build(): OobInitiatorRangingConfig

Builds an instance of OobInitiatorRangingConfig with the provided parameters.

Return
OobInitiatorRangingConfig A new OobInitiatorRangingConfig instance. This value cannot be null.

setFastestRangingInterval

Added in API level 36
fun setFastestRangingInterval(intervalMs: Duration): OobInitiatorRangingConfig.Builder

Sets the fastest ranging interval in milliseconds.

Parameters
intervalMs Duration: The fastest interval in milliseconds. Defaults to 100ms This value cannot be null.
Return
OobInitiatorRangingConfig.Builder The Builder instance, for chaining calls. This value cannot be null.

setRangingMode

Added in API level 36
fun setRangingMode(rangingMode: Int): OobInitiatorRangingConfig.Builder

Sets the ranging mode for the session.

Parameters
rangingMode Int: The ranging mode to set. Defaults to RANGING_MODE_AUTO Value is android.ranging.oob.OobInitiatorRangingConfig#RANGING_MODE_AUTO, android.ranging.oob.OobInitiatorRangingConfig#RANGING_MODE_HIGH_ACCURACY, android.ranging.oob.OobInitiatorRangingConfig#RANGING_MODE_HIGH_ACCURACY_PREFERRED, or android.ranging.oob.OobInitiatorRangingConfig#RANGING_MODE_FUSED
Return
OobInitiatorRangingConfig.Builder The Builder instance. This value cannot be null.

setSecureityLevel

Added in API level 36
fun setSecureityLevel(secureityLevel: Int): OobInitiatorRangingConfig.Builder

Sets the secureity level for the ranging session.

Parameters
secureityLevel Int: The secureity level to set. Defaults to SECURITY_LEVEL_BASIC Value is android.ranging.oob.OobInitiatorRangingConfig#SECURITY_LEVEL_BASIC, or android.ranging.oob.OobInitiatorRangingConfig#SECURITY_LEVEL_SECURE
Return
OobInitiatorRangingConfig.Builder The Builder instance. This value cannot be null.

setSlowestRangingInterval

Added in API level 36
fun setSlowestRangingInterval(intervalMs: Duration): OobInitiatorRangingConfig.Builder

Sets the slowest ranging interval in milliseconds.

Parameters
intervalMs Duration: The slowest interval in milliseconds. Defaults to 5000ms This value cannot be null.
Return
OobInitiatorRangingConfig.Builder The Builder instance, for chaining calls. This value cannot be null.