Added in API level 36

Summary: Ctors | Methods | Inherited Methods

OobInitiatorRangingConfig.Builder

Kotlin |Java

public static final class OobInitiatorRangingConfig.Builder
extends Object

java.lang.Object
↳	android.ranging.oob.OobInitiatorRangingConfig.Builder

Builder class for creating instances of OobInitiatorRangingConfig.

Summary

Public constructors
`Builder()`

Public methods
`OobInitiatorRangingConfig.Builder`	`addDeviceHandle(DeviceHandle deviceHandle)` Adds a DeviceHandle to the list of devices for the ranging session.
`OobInitiatorRangingConfig.Builder`	`addDeviceHandles(List<DeviceHandle> deviceHandles)` Adds a list of DeviceHandle to the list of devices for the ranging session.
`OobInitiatorRangingConfig`	`build()` Builds an instance of `OobInitiatorRangingConfig` with the provided parameters.
`OobInitiatorRangingConfig.Builder`	`setFastestRangingInterval(Duration intervalMs)` Sets the fastest ranging interval in milliseconds.
`OobInitiatorRangingConfig.Builder`	`setRangingMode(int rangingMode)` Sets the ranging mode for the session.
`OobInitiatorRangingConfig.Builder`	`setRangingTechnologyFilter(Set<Integer> rangingTechnologies)` Sets a filter for the ranging technologies that can be used for the session.
`OobInitiatorRangingConfig.Builder`	`setSecurityLevel(int securityLevel)` Sets the security level for the ranging session.
`OobInitiatorRangingConfig.Builder`	`setSlowestRangingInterval(Duration intervalMs)` Sets the slowest ranging interval in milliseconds.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 36

public Builder ()

Public methods

addDeviceHandle

Added in API level 36

public OobInitiatorRangingConfig.Builder addDeviceHandle (DeviceHandle deviceHandle)

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

Parameters
`deviceHandle`	`DeviceHandle`: The DeviceHandle to add. This value cannot be `null`.

Returns
`OobInitiatorRangingConfig.Builder`	The Builder instance. This value cannot be `null`.

addDeviceHandles

Added in API level 36

public OobInitiatorRangingConfig.Builder addDeviceHandles (List<DeviceHandle> deviceHandles)

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

Parameters
`deviceHandles`	`List`: The list of DeviceHandles to add. This value cannot be `null`.

Returns
`OobInitiatorRangingConfig.Builder`	The Builder instance. This value cannot be `null`.

build

Added in API level 36

public OobInitiatorRangingConfig build ()

Builds an instance of OobInitiatorRangingConfig with the provided parameters.

Returns
`OobInitiatorRangingConfig`	A new OobInitiatorRangingConfig instance. This value cannot be `null`.

setFastestRangingInterval

Added in API level 36

public OobInitiatorRangingConfig.Builder setFastestRangingInterval (Duration intervalMs)

Sets the fastest ranging interval in milliseconds.

Parameters
`intervalMs`	`Duration`: The fastest interval in milliseconds. Defaults to 100ms This value cannot be `null`.

Returns
`OobInitiatorRangingConfig.Builder`	The Builder instance, for chaining calls. This value cannot be `null`.

setRangingMode

Added in API level 36

public OobInitiatorRangingConfig.Builder setRangingMode (int rangingMode)

Sets the ranging mode for the session.

Parameters
`rangingMode`	`int`: The ranging mode to set. Defaults to `OobInitiatorRangingConfig.RANGING_MODE_AUTO` Value is `OobInitiatorRangingConfig.RANGING_MODE_AUTO`, `OobInitiatorRangingConfig.RANGING_MODE_HIGH_ACCURACY`, `OobInitiatorRangingConfig.RANGING_MODE_HIGH_ACCURACY_PREFERRED`, or `OobInitiatorRangingConfig.RANGING_MODE_FUSED`

Returns
`OobInitiatorRangingConfig.Builder`	The Builder instance. This value cannot be `null`.

setRangingTechnologyFilter

Added in Android Baklava

public OobInitiatorRangingConfig.Builder setRangingTechnologyFilter (Set<Integer> rangingTechnologies)

Sets a filter for the ranging technologies that can be used for the session.

If this set is empty (the default), the system will attempt to use any available and suitable ranging technology. If the set is non-empty, the system will restrict its choice of technology to those specified in this set.

Parameters
`rangingTechnologies`	`Set`: A `Set` of Ranging Technology integers. Must not be null. To indicate no preference (allow any technology), pass an empty set.

Returns
`OobInitiatorRangingConfig.Builder`	this `Builder` instance. This value cannot be `null`.

setSecurityLevel

Added in API level 36

public OobInitiatorRangingConfig.Builder setSecurityLevel (int securityLevel)

Sets the security level for the ranging session.

Parameters
`securityLevel`	`int`: The security level to set. Defaults to `OobInitiatorRangingConfig.SECURITY_LEVEL_BASIC` Value is `OobInitiatorRangingConfig.SECURITY_LEVEL_BASIC`, or `OobInitiatorRangingConfig.SECURITY_LEVEL_SECURE`

Returns
`OobInitiatorRangingConfig.Builder`	The Builder instance. This value cannot be `null`.

setSlowestRangingInterval

Added in API level 36

public OobInitiatorRangingConfig.Builder setSlowestRangingInterval (Duration intervalMs)

Sets the slowest ranging interval in milliseconds.

Parameters
`intervalMs`	`Duration`: The slowest interval in milliseconds. Defaults to 5000ms This value cannot be `null`.

Returns
`OobInitiatorRangingConfig.Builder`	The Builder instance, for chaining calls. This value cannot be `null`.