Added in API level 30

ControlButton


class ControlButton : Parcelable
kotlin.Any
   ↳ android.service.controls.templates.ControlButton

Button element for ControlTemplate.

Summary

Inherited constants
Public constructors
ControlButton(checked: Boolean, actionDescription: CharSequence)

Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

CharSequence

The content description for this button.

Boolean

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!>

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

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

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 the following:
Return
Unit This value cannot be null.

Properties

CREATOR

Added in API level 30
static val CREATOR: Parcelable.Creator<ControlButton!>