ToggleTemplate

Kotlin |Java

public final class ToggleTemplate
extends ControlTemplate

java.lang.Object
↳	android.service.controls.templates.ControlTemplate
	↳	android.service.controls.templates.ToggleTemplate

A template for a Control with a single button that can be toggled between two states. The states for the toggle correspond to the states in ControlButton#isChecked(). An action on this template will originate a BooleanAction to change that state.

See also:

BooleanAction

Summary

Inherited constants

From class android.service.controls.templates.ControlTemplate

`int`	`TYPE_ERROR` Type identifier of the template returned by `getErrorTemplate()`.
`int`	`TYPE_NO_TEMPLATE` Type identifier of `ControlTemplate#getNoTemplateObject`.
`int`	`TYPE_RANGE` Type identifier of `RangeTemplate`.
`int`	`TYPE_STATELESS` Type identifier of `StatelessTemplate`.
`int`	`TYPE_TEMPERATURE` Type identifier of `TemperatureControlTemplate`.
`int`	`TYPE_THUMBNAIL` Type identifier of `ThumbnailTemplate`.
`int`	`TYPE_TOGGLE` Type identifier of `ToggleTemplate`.
`int`	`TYPE_TOGGLE_RANGE` Type identifier of `ToggleRangeTemplate`.

Public constructors
`ToggleTemplate(String templateId, ControlButton button)`

Public methods
`CharSequence`	`getContentDescription()`
`int`	`getTemplateType()` The template type associated with this class.
`boolean`	`isChecked()`

Inherited methods

From class


        
          android.service.controls.templates.ControlTemplate

`static ControlTemplate`	`getErrorTemplate()`
`static ControlTemplate`	`getNoTemplateObject()` Get a singleton `ControlTemplate`, which supports no direct user input.
`String`	`getTemplateId()`
`abstract int`	`getTemplateType()` The template type associated with this class.

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

ToggleTemplate

Added in API level 30

public ToggleTemplate (String templateId, 
                ControlButton button)

Parameters
`templateId`	`String`: the identifier for this template object This value cannot be `null`.
`button`	`ControlButton`: a `ControlButton` that can show the current state and toggle it This value cannot be `null`.

Public methods

getContentDescription

Added in API level 30

public CharSequence getContentDescription ()

Returns
`CharSequence`	This value cannot be `null`.

getTemplateType

Added in API level 30

public int getTemplateType ()

The template type associated with this class.

Returns
`int`	`ControlTemplate#TYPE_TOGGLE`

isChecked

Added in API level 30

public boolean isChecked ()

Returns
`boolean`