NotificationCompat.Action

const val EMPHASIS_AUTO = 0: Int

The action’s visual emphasis is generally the default, or may be automatically determined by the system based on context.

const val EMPHASIS_PRIMARY = 1: Int

The action’s visual emphasis may indicate that this action is more important than others.

const val EMPHASIS_SECONDARY = 2: Int

The action’s visual emphasis may indicate that this action is less important than others.

const val SEMANTIC_ACTION_ARCHIVE = 5: Int

SemanticAction: Archive the content associated with the notification. This could mean archiving an email, message, etc.

const val SEMANTIC_ACTION_CALL = 10: Int

SemanticAction: Call a contact, group, etc.

const val SEMANTIC_ACTION_DELETE = 4: Int

SemanticAction: Delete the content associated with the notification. This could mean deleting an email, message, etc.

const val SEMANTIC_ACTION_MARK_AS_READ = 2: Int

SemanticAction: Mark content as read.

const val SEMANTIC_ACTION_MARK_AS_UNREAD = 3: Int

SemanticAction: Mark content as unread.

const val SEMANTIC_ACTION_MUTE = 6: Int

SemanticAction: Mute the content associated with the notification. This could mean silencing a conversation or currently playing media.

const val SEMANTIC_ACTION_NONE = 0: Int

SemanticAction: No semantic action defined.

const val SEMANTIC_ACTION_PAUSE = 14: Int

SemanticAction: Pause the content associated with the notification. This could mean pausing media playback, pausing a running timer, etc.

const val SEMANTIC_ACTION_PLAY = 13: Int

SemanticAction: Start (or continue previously paused) content associated with the notification. This could mean starting media playback, resuming a paused timer, etc.

const val SEMANTIC_ACTION_REPLY = 1: Int

SemanticAction: Reply to a conversation, chat, group, or wherever replies may be appropriate.

const val SEMANTIC_ACTION_STOP = 15: Int

SemanticAction: Stop the content associated with the notification. This could mean stopping media playback, resetting a timer, etc. It is implied that a follow-up SEMANTIC_ACTION_PLAY would restart from the beginning, or may not be offered at all.

const val SEMANTIC_ACTION_THUMBS_DOWN = 9: Int

SemanticAction: Mark content with a thumbs down.

const val SEMANTIC_ACTION_THUMBS_UP = 8: Int

SemanticAction: Mark content with a thumbs up.

const val SEMANTIC_ACTION_UNMUTE = 7: Int

SemanticAction: Unmute the content associated with the notification. This could mean un-silencing a conversation or currently playing media.

const val STYLE_AUTO = 0: Int

The action can be presented with the best form for the content and context.

const val STYLE_ICON_AND_TEXT = 2: Int

The action is best represented by a combo of the icon and text.

const val STYLE_ICON_ONLY = 3: Int

The action is best represented by only its icon.

const val STYLE_TEXT_ONLY = 1: Int

The action is best represented by only the text (its title).

Action(icon: IconCompat?, title: CharSequence?, intent: PendingIntent?)

Note: For devices running an Android version strictly lower than API level 23 this constructor only supports resource-ID based IconCompat objects.

fun getAllowGeneratedReplies(): Boolean

Return whether the platform should automatically generate possible replies for this Action

fun getDataOnlyRemoteInputs(): Array<RemoteInput!>?

Get the list of inputs to be collected from the user that ONLY accept data when this action is sent. These remote inputs are guaranteed to return true on a call to isDataOnly.

May return null if no data-only remote inputs were added.

This method exists so that legacy RemoteInput collectors that pre-date the addition of non-textual RemoteInputs do not access these remote inputs.

fun getEmphasisHint(): Int

Returns the app’s hint about the importance of this action relative to others in this notification.

fun getExtras(): Bundle

Get additional metadata carried around with this Action.

fun getIconCompat(): IconCompat?

Return the icon associated with this Action.

fun getRemoteInputs(): Array<RemoteInput!>?

Get the list of inputs to be collected from the user when this action is sent. May return null if no remote inputs were added. Only returns inputs which accept a text input. For inputs which only accept data use getDataOnlyRemoteInputs.

@NotificationCompat.Action.SemanticAction
fun getSemanticAction(): Int

Returns the SemanticAction associated with this Action. A SemanticAction denotes what an Action's PendingIntent will do (eg. reply, mark as read, delete, etc).

fun getShowsUserInterface(): Boolean

Return whether or not triggering this Action's PendingIntent will open a user interface.

fun getStyleHint(): Int

Returns the app’s hint about the preferred visual style of this action.

fun isAuthenticationRequired(): Boolean

Returns whether the OS should only send this action's PendingIntent on an unlocked device. If the device is locked when the action is invoked, the OS should show the keyguard and require successful authentication before invoking the intent.

fun isContextual(): Boolean

Returns whether this is a contextual Action, i.e. whether the action is dependent on the notification message body. An example of a contextual action could be an action opening a map application with an address shown in the notification.

val actionIntent: PendingIntent?

Intent to send when the user invokes this action. May be null, in which case the action may be rendered in a disabled presentation.

val icon: Int

Small icon representing the action.

val title: CharSequence?

Title of the action.