Added in Android Baklava

Summary: Ctors | Methods | Inherited Methods

RangingPreference.Builder

---

Kotlin |Java

public static final class RangingPreference.Builder
extends Object

java.lang.Object
↳	android.ranging.RangingPreference.Builder

---

Builder for creating instances of RangingPreference.

This Builder class provides a flexible way to construct a RangingPreference instance by setting required and optional parameters. It ensures that all necessary parameters are specified and provides default values for optional configurations.

Example usage:

RangingPreference rangingPreference = new RangingPreference.Builder(DEVICE_ROLE_RESPONDER,
     new RawResponderRangingParams.Builder()
         .setRawRangingDevice(
             new RawRangingDevice.Builder()
                 .setRangingDevice(
                     new RangingDevice.Builder()
                         .build())
                .setBleRssiRangingParams(
                new BleRssiRangingParams.Builder("AA:BB:CC:00:11:22")
                    .build())
            .build())
        build())
    .build();
 

Summary

Public constructors
Builder(int role, RangingConfig rangingConfig) Creates a Builder instance with the required device role and RangingConfig.

Public methods
RangingPreference	build() Builds the RangingPreference instance.
RangingPreference.Builder	setSessionConfig(SessionConfig config) Sets the configuration parameters for the ranging session policy.

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 Android Baklava

public Builder (int role, 
                RangingConfig rangingConfig)

Creates a Builder instance with the required device role and RangingConfig.

Parameters
role	int: the role of the device in ERROR(DeviceRole/android.ranging.RangingPreference.DeviceRole DeviceRole) Value is RangingPreference.DEVICE_ROLE_RESPONDER, or RangingPreference.DEVICE_ROLE_INITIATOR
rangingConfig	RangingConfig: the RangingConfig to use. Needs to be an instance of one of the following: RawResponderRangingConfig RawInitiatorRangingConfig OobResponderRangingConfig OobInitiatorRangingConfig This value cannot be null.

Throws
NullPointerException	if rangingParams is null.

Public methods

build

Added in Android Baklava

public RangingPreference build ()

Builds the RangingPreference instance.

If the SessionConfig is not set, default instances will be used.

Returns
RangingPreference	a new RangingPreference instance. This value cannot be null.

setSessionConfig

Added in Android Baklava

public RangingPreference.Builder setSessionConfig (SessionConfig config)

Sets the configuration parameters for the ranging session policy.

This method allows specifying additional configuration parameters encapsulated in SessionConfig for fine-tuning the behavior of the ranging session.

Parameters
config	SessionConfig: the SessionConfig. This value cannot be null.

Returns
RangingPreference.Builder	this Builder instance. This value cannot be null.

Throws
NullPointerException	if params is null.