SliceAction

Kotlin |Java

@RequiresApi(19) interface SliceAction

Known Direct Subclasses

Class representing an action, supports tappable icons, custom toggle icons, and default toggles.

Interface for a slice action, supports tappable icons, custom toggle icons, and default toggles.

Summary

Public methods
abstract PendingIntent	`getAction()`
abstract CharSequence?	`getContentDescription()`
abstract IconCompat?	`getIcon()`
abstract Int	`getImageMode()`
abstract Int	`getPriority()`
abstract CharSequence	`getTitle()`
abstract Boolean	`isActivity()`
abstract Boolean	`isChecked()`
abstract Boolean	`isDefaultToggle()`
abstract Boolean	`isToggle()`
abstract SliceAction!	`setChecked(isChecked: Boolean)`
abstract SliceAction?	`setContentDescription(@NonNull description: CharSequence)`
abstract SliceAction!	`setPriority(@IntRange(0) priority: Int)` Sets the priority of this action, with the lowest priority having the highest ranking.

@NonNull abstract fun getAction(): PendingIntent

Return
`PendingIntent`	the `PendingIntent` associated with this action.

@Nullable abstract fun getContentDescription(): CharSequence?

Return
`CharSequence?`	the content description to use for this action.

@Nullable abstract fun getIcon(): IconCompat?

Return
`IconCompat?`	the `IconCompat` to display for this action. This can be null when the action represented is a default toggle.

abstract fun getImageMode(): Int

Return
`Int`	the image mode to use for this action.

abstract fun getPriority(): Int

Return
`Int`	the priority associated with this action, -1 if unset.

@NonNull abstract fun getTitle(): CharSequence

Return
`CharSequence`	the title for this action.

abstract fun isActivity(): Boolean

Return
`Boolean`	whether this activity launches an activity or not.

abstract fun isChecked(): Boolean

Return
`Boolean`	whether the state of this action is checked or not; only used for toggle actions.

abstract fun isDefaultToggle(): Boolean

Return
`Boolean`	whether this action is a toggle using the standard switch control.

abstract fun isToggle(): Boolean

Return
`Boolean`	whether this action represents a toggle (i.e. has a checked and unchecked state).

abstract fun setChecked(isChecked: Boolean): SliceAction!

Parameters
`isChecked`	Boolean: whether the state of this action is checked or not; only used for toggle actions.

@Nullable abstract fun setContentDescription(@NonNull description: CharSequence): SliceAction?

Parameters
`description`	CharSequence: the content description for this action.

abstract fun setPriority(@IntRange(0) priority: Int): SliceAction!

Sets the priority of this action, with the lowest priority having the highest ranking.