ControlButton


public final class ControlButton
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.controls.templates.ControlButton


Button element for ControlTemplate.

Summary

Inherited constants

Fields

public static final Creator<ControlButton> CREATOR

Public constructors

ControlButton(boolean checked, CharSequence actionDescription)

Public methods

int describeContents()

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

CharSequence getActionDescription()

The content description for this button.

boolean isChecked()

Whether the button should be rendered in a checked state.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 30
public static final Creator<ControlButton> CREATOR

Public constructors

ControlButton

Added in API level 30
public ControlButton (boolean checked, 
                CharSequence actionDescription)

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
public int describeContents ()

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.

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

getActionDescription

Added in API level 30
public CharSequence getActionDescription ()

The content description for this button.

Returns
CharSequence This value cannot be null.

isChecked

Added in API level 30
public boolean isChecked ()

Whether the button should be rendered in a checked state.

Returns
boolean

writeToParcel

Added in API level 30
public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Returns
void This value cannot be null.