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

# Builder

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/android/hardware/lights/LightsRequest.Builder "View this page in Java")

```
class Builder
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.hardware.lights.LightsRequest.Builder](https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#) |

Builder for creating device light change requests.

## Summary

| Public constructors ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#Builder()()` <br /> |

| Public methods ||
|---|---|
| [LightsRequest.Builder](https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#) | `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#addLight(android.hardware.lights.Light,%20android.hardware.lights.LightState)(light: https://developer.android.com/reference/kotlin/android/hardware/lights/Light, state: https://developer.android.com/reference/kotlin/android/hardware/lights/LightState)` Overrides the color and intensity of a given light. |
| [LightsRequest](https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest) | `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#build()()` Create a LightsRequest object used to override lights on the device. |
| [LightsRequest.Builder](https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#) | `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#clearLight(android.hardware.lights.Light)(light: https://developer.android.com/reference/kotlin/android/hardware/lights/Light)` Removes the override for the color and intensity of a given light. |

## Public constructors

### Builder

```
Builder()
```

## Public methods

### addLight

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

```
fun addLight(
    light: Light, 
    state: LightState
): LightsRequest.Builder
```

Overrides the color and intensity of a given light.

| Parameters ||
|---|---|
| `light` | [Light](https://developer.android.com/reference/kotlin/android/hardware/lights/Light): the light to modify. This value cannot be `null`. |
| `state` | [LightState](https://developer.android.com/reference/kotlin/android/hardware/lights/LightState): the desired color and intensity of the light. This value cannot be `null`. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#` | This value cannot be `null`. |

### build

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

```
fun build(): LightsRequest
```

Create a LightsRequest object used to override lights on the device.

The generated `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest` should be used in `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsManager.LightsSession#requestLights(android.hardware.lights.LightsRequest)`.

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest` | This value cannot be `null`. |

### clearLight

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

```
fun clearLight(light: Light): LightsRequest.Builder
```

Removes the override for the color and intensity of a given light.

| Parameters ||
|---|---|
| `light` | [Light](https://developer.android.com/reference/kotlin/android/hardware/lights/Light): the light to modify. This value cannot be `null`. |

| Return ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/hardware/lights/LightsRequest.Builder#` | This value cannot be `null`. |