Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/ranging/RangingPreference.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/ranging/RangingPreference.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/RangingPreference.Builder#inhmethods)

# RangingPreference.Builder

*** ** * ** ***

` public static final class RangingPreference.Builder `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.ranging.RangingPreference.Builder |

<br />

*** ** * ** ***

Builder for creating instances of `RangingPreference`.

This Builder class provides a flexible way to construct a `https://developer.android.com/reference/android/ranging/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();

<br />

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/ranging/RangingPreference.Builder#Builder(int,%20android.ranging.RangingConfig)(int role, https://developer.android.com/reference/android/ranging/RangingConfig rangingConfig) ` Creates a Builder instance with the required device role and `https://developer.android.com/reference/android/ranging/RangingConfig`. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/ranging/RangingPreference` | ` https://developer.android.com/reference/android/ranging/RangingPreference.Builder#build()() ` Builds the `RangingPreference` instance. |
| ` https://developer.android.com/reference/android/ranging/RangingPreference.Builder` | ` https://developer.android.com/reference/android/ranging/RangingPreference.Builder#setSessionConfig(android.ranging.SessionConfig)(https://developer.android.com/reference/android/ranging/SessionConfig config) ` Sets the configuration parameters for the ranging session policy. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Builder (int role, 
                RangingConfig rangingConfig)
```

Creates a Builder instance with the required device role and `https://developer.android.com/reference/android/ranging/RangingConfig`.

<br />

| Parameters ||
|---|---|
| `role` | `int`: the role of the device in `https://developer.android.com/` Value is one of the following: - `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_RESPONDER` - `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_INITIATOR` - `https://developer.android.com/reference/android/ranging/RangingPreference#DEVICE_ROLE_DT_TAG` |
| `rangingConfig` | `RangingConfig`: the `https://developer.android.com/reference/android/ranging/RangingConfig` to use. Needs to be an instance of one of the following: - `https://developer.android.com/` - `https://developer.android.com/` - `https://developer.android.com/` - `https://developer.android.com/` . This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `rangingConfig` is null. |

## Public methods

### build

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public RangingPreference build ()
```

Builds the `RangingPreference` instance.

If the `https://developer.android.com/reference/android/ranging/SessionConfig` is not set, default instances will be used.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/RangingPreference` | a new `RangingPreference` instance. This value cannot be `null`. <br /> |

### setSessionConfig

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public RangingPreference.Builder setSessionConfig (SessionConfig config)
```

Sets the configuration parameters for the ranging session policy.

This method allows specifying additional configuration parameters encapsulated in `https://developer.android.com/reference/android/ranging/SessionConfig` for fine-tuning the behavior of the ranging session.

<br />

| Parameters ||
|---|---|
| `config` | `SessionConfig`: the `https://developer.android.com/reference/android/ranging/SessionConfig`. This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/ranging/RangingPreference.Builder` | this `https://developer.android.com/reference/android/ranging/RangingPreference.Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `config` is null. |