Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/hardware/lights/LightsRequest#nestedclasses) \| [Methods](https://developer.android.com/reference/android/hardware/lights/LightsRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/lights/LightsRequest#inhmethods)

# LightsRequest

*** ** * ** ***


`
public

final

class
LightsRequest
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.lights.LightsRequest |

<br />

*** ** * ** ***

Encapsulates a request to modify the state of multiple lights.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/hardware/lights/LightsRequest.Builder` Builder for creating device light change requests. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/hardware/lights/MultiLightEffect` | ` https://developer.android.com/reference/android/hardware/lights/LightsRequest#getEffect()() ` Get the configured effect. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/hardware/lights/LightState>` | ` https://developer.android.com/reference/android/hardware/lights/LightsRequest#getLightStates()() ` Get a list of LightState. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/Integer>` | ` https://developer.android.com/reference/android/hardware/lights/LightsRequest#getLights()() ` Get a list of Light as ids. |
| ` https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/android/hardware/lights/Light, https://developer.android.com/reference/android/hardware/lights/LightState>` | ` https://developer.android.com/reference/android/hardware/lights/LightsRequest#getLightsAndStates()() ` Get a map of lights and states. |

| ### 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 methods

### getEffect

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

```
public MultiLightEffect getEffect ()
```

Get the configured effect.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/hardware/lights/MultiLightEffect` | configured effects in this request. This value may be `null`. <br /> |

### getLightStates

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

```
public List<LightState> getLightStates ()
```

Get a list of LightState. The states will be returned in same order as the light ids
returned by `https://developer.android.com/reference/android/hardware/lights/LightsRequest#getLights()`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/hardware/lights/LightState>` | List of light states. This value cannot be `null`. <br /> |

### getLights

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

```
public List<Integer> getLights ()
```

Get a list of Light as ids.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/java/lang/Integer>` | List of light ids in the request. This value cannot be `null`. <br /> |

### getLightsAndStates

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

```
public Map<Light, LightState> getLightsAndStates ()
```

Get a map of lights and states. The map will contain all the lights as keys and
the corresponding LightState requested as values.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Map<https://developer.android.com/reference/android/hardware/lights/Light, https://developer.android.com/reference/android/hardware/lights/LightState>` | This value cannot be `null`. <br /> |