BooleanAction

Kotlin |Java

public final class BooleanAction
extends ControlAction

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

Action sent by user toggling a Control between checked/unchecked. This action is available when the Control was constructed with either a ToggleTemplate or a ToggleRangeTemplate.

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
`BooleanAction(String templateId, boolean newState)`
`BooleanAction(String templateId, boolean newState, String challengeValue)`

Public methods
`int`	`getActionType()` The `ActionType` associated with this class.
`boolean`	`getNewState()` The new state set for the button in the corresponding `ToggleTemplate`.

From class


        
          android.service.controls.actions.ControlAction

`abstract int`	`getActionType()` The `ActionType` 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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Added in API level 30

public BooleanAction (String templateId, 
                boolean newState)

Parameters
`templateId`	`String`: the identifier of the `ToggleTemplate` that produced this action. This value cannot be `null`.
`newState`	`boolean`: new value for the state displayed by the `ToggleTemplate`.

Added in API level 30

public BooleanAction (String templateId, 
                boolean newState, 
                String challengeValue)

Parameters
`templateId`	`String`: the identifier of the template that originated this action. This value cannot be `null`.
`newState`	`boolean`: new value for the state displayed by the template.
`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. This value may be `null`.

Added in API level 30

public int getActionType ()

The ActionType associated with this class.

Returns
`int`	`ControlAction#TYPE_BOOLEAN`

Added in API level 30

public boolean getNewState ()

The new state set for the button in the corresponding ToggleTemplate.

Returns
`boolean`	`true` if the button was toggled from unchecked to checked.