Added in API level 31
LightsRequest
public
final
class
LightsRequest
extends Object
| java.lang.Object | |
| ↳ | android.hardware.lights.LightsRequest |
Encapsulates a request to modify the state of multiple lights.
Summary
Nested classes | |
|---|---|
class |
LightsRequest.Builder
Builder for creating device light change requests. |
Public methods | |
|---|---|
List<LightState>
|
getLightStates()
Get a list of LightState. |
List<Integer>
|
getLights()
Get a list of Light as ids. |
Map<Light, LightState>
|
getLightsAndStates()
Get a map of lights and states. |
Inherited methods | |
|---|---|
Public methods
getLightStates
Added in API level 31
public List<LightState> getLightStates ()
Get a list of LightState. The states will be returned in same order as the light ids
returned by getLights().
| Returns | |
|---|---|
List<LightState> |
List of light states
This value cannot be null. |
getLights
Added in API level 31
public List<Integer> getLights ()
Get a list of Light as ids.
| Returns | |
|---|---|
List<Integer> |
List of light ids in the request.
This value cannot be null. |
getLightsAndStates
Added in API level 31
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.
| Returns | |
|---|---|
Map<Light, LightState> |
This value cannot be null. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# LightsRequest\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Nested Classes](#nestedclasses) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nLightsRequest\n=============\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/hardware/lights/LightsRequest \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\nfinal\n\nclass\nLightsRequest\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|---------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.hardware.lights.LightsRequest |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nEncapsulates a request to modify the state of multiple lights.\n\nSummary\n-------\n\n| ### Nested classes ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------|\n| ` class` | [LightsRequest.Builder](/reference/android/hardware/lights/LightsRequest.Builder) Builder for creating device light change requests. |\n\n| ### Public methods ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[List](/reference/java/util/List)`\u003c`[LightState](/reference/android/hardware/lights/LightState)`\u003e` | ` `[getLightStates](/reference/android/hardware/lights/LightsRequest#getLightStates())`() ` Get a list of LightState. |\n| ` `[List](/reference/java/util/List)`\u003c`[Integer](/reference/java/lang/Integer)`\u003e` | ` `[getLights](/reference/android/hardware/lights/LightsRequest#getLights())`() ` Get a list of Light as ids. |\n| ` `[Map](/reference/java/util/Map)`\u003c`[Light](/reference/android/hardware/lights/Light)`, `[LightState](/reference/android/hardware/lights/LightState)`\u003e` | ` `[getLightsAndStates](/reference/android/hardware/lights/LightsRequest#getLightsAndStates())`() ` Get a map of lights and states. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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 `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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` | ` `[wait](/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` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### getLightStates\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic List\u003cLightState\u003e getLightStates ()\n```\n\nGet a list of LightState. The states will be returned in same order as the light ids\nreturned by [getLights()](/reference/android/hardware/lights/LightsRequest#getLights()).\n\n\u003cbr /\u003e\n\n| Returns ||\n|----------------------------------------------------------------------------------------------------|----------------------------------------------------------|\n| [List](/reference/java/util/List)`\u003c`[LightState](/reference/android/hardware/lights/LightState)`\u003e` | List of light states This value cannot be `null`. \u003cbr /\u003e |\n\n### getLights\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic List\u003cInteger\u003e getLights ()\n```\n\nGet a list of Light as ids.\n\n\u003cbr /\u003e\n\n| Returns ||\n|--------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [List](/reference/java/util/List)`\u003c`[Integer](/reference/java/lang/Integer)`\u003e` | List of light ids in the request. This value cannot be `null`. \u003cbr /\u003e |\n\n### getLightsAndStates\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic Map\u003cLight, LightState\u003e getLightsAndStates ()\n```\n\nGet a map of lights and states. The map will contain all the lights as keys and\nthe corresponding LightState requested as values.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|\n| [Map](/reference/java/util/Map)`\u003c`[Light](/reference/android/hardware/lights/Light)`, `[LightState](/reference/android/hardware/lights/LightState)`\u003e` | This value cannot be `null`. \u003cbr /\u003e |"]]