Stay organized with collections
Save and categorize content based on your preferences.
LightsRequest.Builder
public
static
final
class
LightsRequest.Builder
extends Object
Builder for creating device light change requests.
Summary
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
public Builder ()
Public methods
addLight
public LightsRequest.Builder addLight (Light light,
LightState state)
Overrides the color and intensity of a given light.
| Parameters |
|---|
light |
Light: the light to modify
This value cannot be null. |
state |
LightState: the desired color and intensity of the light
This value cannot be null. |
build
public LightsRequest build ()
Create a LightsRequest object used to override lights on the device.
The generated LightsRequest should be used in
{@link LightsManager.Session#requestLights(LightsLightsRequest).
clearLight
public LightsRequest.Builder clearLight (Light light)
Removes the override for the color and intensity of a given light.
| Parameters |
|---|
light |
Light: the light to modify
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.Builder\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nLightsRequest.Builder\n=====================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/hardware/lights/LightsRequest.Builder \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nLightsRequest.Builder\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.Builder |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nBuilder for creating device light change requests.\n\nSummary\n-------\n\n| ### Public constructors ||\n|---------------------------------------------------------------------------------------|---|\n| ` `[Builder](/reference/android/hardware/lights/LightsRequest.Builder#Builder())`() ` |\n\n| ### Public methods ||\n|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[LightsRequest.Builder](/reference/android/hardware/lights/LightsRequest.Builder) | ` `[addLight](/reference/android/hardware/lights/LightsRequest.Builder#addLight(android.hardware.lights.Light,%20android.hardware.lights.LightState))`(`[Light](/reference/android/hardware/lights/Light)` light, `[LightState](/reference/android/hardware/lights/LightState)` state) ` Overrides the color and intensity of a given light. |\n| ` `[LightsRequest](/reference/android/hardware/lights/LightsRequest) | ` `[build](/reference/android/hardware/lights/LightsRequest.Builder#build())`() ` Create a LightsRequest object used to override lights on the device. |\n| ` `[LightsRequest.Builder](/reference/android/hardware/lights/LightsRequest.Builder) | ` `[clearLight](/reference/android/hardware/lights/LightsRequest.Builder#clearLight(android.hardware.lights.Light))`(`[Light](/reference/android/hardware/lights/Light)` light) ` Removes the override for the color and intensity of a given light. |\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 constructors\n-------------------\n\n### Builder\n\n```\npublic Builder ()\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nPublic methods\n--------------\n\n### addLight\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic LightsRequest.Builder addLight (Light light, \n LightState state)\n```\n\nOverrides the color and intensity of a given light.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|------------------------------------------------------------------------------------------------|\n| `light` | `Light`: the light to modify This value cannot be `null`. \u003cbr /\u003e |\n| `state` | `LightState`: the desired color and intensity of the light This value cannot be `null`. \u003cbr /\u003e |\n\n| Returns ||\n|-----------------------------------------------------------------------------------|-------------------------------------|\n| [LightsRequest.Builder](/reference/android/hardware/lights/LightsRequest.Builder) | This value cannot be `null`. \u003cbr /\u003e |\n\n### build\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic LightsRequest build ()\n```\n\nCreate a LightsRequest object used to override lights on the device.\n\nThe generated [LightsRequest](/reference/android/hardware/lights/LightsRequest) should be used in\n{@link LightsManager.Session#requestLights(LightsLightsRequest).\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------------------------------------------------------------------|-------------------------------------|\n| [LightsRequest](/reference/android/hardware/lights/LightsRequest) | This value cannot be `null`. \u003cbr /\u003e |\n\n### clearLight\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic LightsRequest.Builder clearLight (Light light)\n```\n\nRemoves the override for the color and intensity of a given light.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|------------------------------------------------------------------|\n| `light` | `Light`: the light to modify This value cannot be `null`. \u003cbr /\u003e |\n\n| Returns ||\n|-----------------------------------------------------------------------------------|-------------------------------------|\n| [LightsRequest.Builder](/reference/android/hardware/lights/LightsRequest.Builder) | This value cannot be `null`. \u003cbr /\u003e |"]]
