Action

Kotlin |Java

open class Action

kotlin.Any
↳	androidx.leanback.widget.Action

Known Direct Subclasses

GuidedAction, PlaybackControlsRow.MoreActions, PlaybackControlsRow.MultiAction, PlaybackControlsRow.PictureInPictureAction, PlaybackControlsRow.SkipNextAction, PlaybackControlsRow.SkipPreviousAction

GuidedAction	A data class which represents an action within a .
PlaybackControlsRow.MoreActions	An action displaying an icon for "more actions".
PlaybackControlsRow.MultiAction	Base class for an action comprised of a series of icons.
PlaybackControlsRow.PictureInPictureAction	An action displaying an icon for picture-in-picture.
PlaybackControlsRow.SkipNextAction	An action displaying an icon for skip next.
PlaybackControlsRow.SkipPreviousAction	An action displaying an icon for skip previous.

Known Indirect Subclasses

GuidedDatePickerAction, PlaybackControlsRow.ClosedCaptioningAction, PlaybackControlsRow.FastForwardAction, PlaybackControlsRow.HighQualityAction, PlaybackControlsRow.PlayPauseAction, PlaybackControlsRow.RepeatAction, PlaybackControlsRow.RewindAction, PlaybackControlsRow.ShuffleAction, PlaybackControlsRow.ThumbsAction, PlaybackControlsRow.ThumbsDownAction, PlaybackControlsRow.ThumbsUpAction

GuidedDatePickerAction	Subclass of GuidedAction that can choose a date.
PlaybackControlsRow.ClosedCaptioningAction	An action for displaying a CC (Closed Captioning) icon.
PlaybackControlsRow.FastForwardAction	An action displaying an icon for fast forward.
PlaybackControlsRow.HighQualityAction	An action for displaying a HQ (High Quality) icon.
PlaybackControlsRow.PlayPauseAction	An action displaying icons for play and pause.
PlaybackControlsRow.RepeatAction	An action for displaying three repeat states: none, one, or all.
PlaybackControlsRow.RewindAction	An action displaying an icon for rewind.
PlaybackControlsRow.ShuffleAction	An action for displaying a shuffle icon.
PlaybackControlsRow.ThumbsAction	A base class for displaying a thumbs action.
PlaybackControlsRow.ThumbsDownAction	An action displaying an icon for thumbs down.
PlaybackControlsRow.ThumbsUpAction	An action displaying an icon for thumbs up.

An action contains one or two lines of text, an optional image and an optional id. It may also be invoked by one or more keycodes.

Summary

Constants
static Long	`NO_ID` Indicates that an id has not been set.

Public constructors
`<init>(id: Long)` Constructor for an Action.
`<init>(id: Long, label: CharSequence!)` Constructor for an Action.
`<init>(id: Long, label1: CharSequence!, label2: CharSequence!)` Constructor for an Action.
`<init>(id: Long, label1: CharSequence!, label2: CharSequence!, icon: Drawable!)` Constructor for an Action.

Public methods
Unit	`addKeyCode(keyCode: Int)` Adds a keycode used to invoke this Action.
Drawable!	`getIcon()` Returns the icon drawable for this Action.
Long	`getId()` Returns the id for this Action.
CharSequence!	`getLabel1()` Returns the first line label for this Action.
CharSequence!	`getLabel2()` Returns the second line label for this Action.
Unit	`removeKeyCode(keyCode: Int)` Removes a keycode used to invoke this Action.
Boolean	`respondsToKeyCode(keyCode: Int)` Returns true if the Action should respond to the given keycode.
Unit	`setIcon(icon: Drawable!)` Sets the icon drawable for this Action.
Unit	`setId(id: Long)` Sets the id for this Action.
Unit	`setLabel1(label: CharSequence!)` Sets the first line label for this Action.
Unit	`setLabel2(label: CharSequence!)` Sets the second line label for this Action.
open String	`toString()`

Constants

NO_ID

static val NO_ID: Long

Indicates that an id has not been set.

Value: -1

Public constructors

<init>

Action(id: Long)

Constructor for an Action.

Parameters
`id`	Long: The id of the Action.

<init>

Action(
    id: Long, 
    label: CharSequence!)

Constructor for an Action.

Parameters
`id`	Long: The id of the Action.
`label`	CharSequence!: The label to display for the Action.

<init>

Action(
    id: Long, 
    label1: CharSequence!, 
    label2: CharSequence!)

Constructor for an Action.

Parameters
`id`	Long: The id of the Action.
`label1`	CharSequence!: The label to display on the first line of the Action.
`label2`	CharSequence!: The label to display on the second line of the Action.

<init>

Action(
    id: Long, 
    label1: CharSequence!, 
    label2: CharSequence!, 
    icon: Drawable!)

Constructor for an Action.

Parameters
`id`	Long: The id of the Action.
`label1`	CharSequence!: The label to display on the first line of the Action.
`label2`	CharSequence!: The label to display on the second line of the Action.
`icon`	Drawable!: The icon to display for the Action.

Public methods

addKeyCode

fun addKeyCode(keyCode: Int): Unit

Adds a keycode used to invoke this Action.

getIcon

fun getIcon(): Drawable!

Returns the icon drawable for this Action.

getId

fun getId(): Long

Returns the id for this Action.

getLabel1

fun getLabel1(): CharSequence!

Returns the first line label for this Action.

getLabel2

fun getLabel2(): CharSequence!

Returns the second line label for this Action.

removeKeyCode

fun removeKeyCode(keyCode: Int): Unit

Removes a keycode used to invoke this Action.

respondsToKeyCode

fun respondsToKeyCode(keyCode: Int): Boolean

Returns true if the Action should respond to the given keycode.

setIcon

fun setIcon(icon: Drawable!): Unit

Sets the icon drawable for this Action.

setId

fun setId(id: Long): Unit

Sets the id for this Action.

setLabel1

fun setLabel1(label: CharSequence!): Unit

Sets the first line label for this Action.

setLabel2

fun setLabel2(label: CharSequence!): Unit

Sets the second line label for this Action.

toString

open fun toString(): String