ControlButton

Kotlin |Java

class ControlButton : Parcelable

kotlin.Any
↳	android.service.controls.templates.ControlButton

Button element for ControlTemplate.

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`ControlButton(checked: Boolean, actionDescription: CharSequence)`

Public methods
Int	`describeContents()`
CharSequence	`getActionDescription()` The content description for this button.
Boolean	`isChecked()` Whether the button should be rendered in a checked state.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ControlButton!>	`CREATOR`

Public constructors

ControlButton

Added in API level 30

ControlButton(
    checked: Boolean, 
    actionDescription: CharSequence)

Parameters
`checked`	Boolean: true if the button should be rendered as active.
`actionDescription`	CharSequence: action description for the button. This value cannot be `null`.

Public methods

describeContents

Added in API level 30

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getActionDescription

Added in API level 30

fun getActionDescription(): CharSequence

The content description for this button.

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

isChecked

Added in API level 30

fun isChecked(): Boolean

Whether the button should be rendered in a checked state.

writeToParcel

Added in API level 30

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Return
`Unit`	This value cannot be `null`.

Properties

CREATOR

Added in API level 30

static val CREATOR: Parcelable.Creator<ControlButton!>