ModeAction

Kotlin |Java

public final class ModeAction
extends ControlAction

java.lang.Object
↳	android.service.controls.actions.ControlAction
	↳	android.service.controls.actions.ModeAction

Action sent by the user to indicate a change of mode. This action is available when the Control was created with a TemperatureControlTemplate.

Summary

From class android.service.controls.actions.ControlAction

`int`	`RESPONSE_CHALLENGE_ACK` Response code for the `consumer` in `ControlsProviderService#performControlAction` indicating that in order for the action to be performed, acknowledgment from the user is required.
`int`	`RESPONSE_CHALLENGE_PASSPHRASE` Response code for the `consumer` in `ControlsProviderService#performControlAction` indicating that in order for the action to be performed, an alphanumeric passphrase is required.
`int`	`RESPONSE_CHALLENGE_PIN` Response code for the `consumer` in `ControlsProviderService#performControlAction` indicating that in order for the action to be performed, a PIN is required.
`int`	`RESPONSE_FAIL` Response code for the `consumer` in `ControlsProviderService#performControlAction` indicating that the action has failed.
`int`	`RESPONSE_OK` Response code for the `consumer` in `ControlsProviderService#performControlAction` indicating that the action has been performed.
`int`	`RESPONSE_UNKNOWN` Value is `RESPONSE_UNKNOWN`, `RESPONSE_OK`, `RESPONSE_FAIL`, `RESPONSE_CHALLENGE_ACK`, `RESPONSE_CHALLENGE_PIN`, or `RESPONSE_CHALLENGE_PASSPHRASE`
`int`	`TYPE_BOOLEAN` The identifier of `BooleanAction`.
`int`	`TYPE_COMMAND` The identifier of `CommandAction`.
`int`	`TYPE_ERROR` The identifier of the action returned by `getErrorAction()`.
`int`	`TYPE_FLOAT` The identifier of `FloatAction`.
`int`	`TYPE_MODE` The identifier of `ModeAction`.

Public constructors
`ModeAction(String templateId, int newMode, String challengeValue)`
`ModeAction(String templateId, int newMode)`

Public methods
`int`	`getActionType()` The action type associated with this class.
`int`	`getNewMode()`

From class


        
          android.service.controls.actions.ControlAction

`abstract int`	`getActionType()` The action type associated with this class.
`String`	`getChallengeValue()` The challenge value used to authenticate certain actions, if available.
`static ControlAction`	`getErrorAction()` Returns a singleton `ControlAction` used for indicating an error in unparceling.
`String`	`getTemplateId()` The identifier of the `ControlTemplate` that originated this action
`static final boolean`	`isValidResponse(int response)`

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.

Added in API level 30

public ModeAction (String templateId, 
                int newMode, 
                String challengeValue)

Parameters
`templateId`	`String`: the identifier of the `TemperatureControlTemplate` that originated this action. This value cannot be `null`.
`newMode`	`int`: new value for the mode.
`challengeValue`	`String`: a value sent by the user along with the action to authenticate. null is sent when no authentication is needed or has not been requested.

Added in API level 30

public ModeAction (String templateId, 
                int newMode)

Parameters
`templateId`	`String`: the identifier of the `TemperatureControlTemplate` that originated this action. This value cannot be `null`.
`newMode`	`int`: new value for the mode.

Added in API level 30

public int getActionType ()

The action type associated with this class.

Returns
`int`	`ControlAction#TYPE_MODE`.

Added in API level 30

public int getNewMode ()

Returns
`int`