Action
open class Action
| kotlin.Any | |
| ↳ | androidx.core.app.NotificationCompat.Action |
Structure to encapsulate a named action that can be shown as part of this notification. It must include an icon, a label, and a PendingIntent to be fired when the action is selected by the user. Action buttons won't appear on platforms prior to Android 4.1.
Apps should use NotificationCompat.Builder#addAction(int, CharSequence, PendingIntent) or NotificationCompat.Builder#addAction(NotificationCompat.Action) to attach actions.
Summary
Nested classes |
|
|---|---|
|
Builder class for |
|
| abstract |
Extender interface for use with |
|
Provides meaning to an |
|
|
Wearable extender for notification actions. |
|
Constants |
|
|---|---|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
| static Int |
|
Public constructors |
|
|---|---|
<init>(icon: Int, title: CharSequence!, intent: PendingIntent!) |
|
<init>(@Nullable icon: IconCompat?, @Nullable title: CharSequence?, @Nullable intent: PendingIntent?)Note: For devices running an Android version strictly lower than API level 23 this constructor only supports resource-ID based IconCompat objects. |
|
Public methods |
|
|---|---|
| open PendingIntent! | |
| open Boolean |
Return whether the platform should automatically generate possible replies for this |
| open Array<RemoteInput!>! |
Get the list of inputs to be collected from the user that ONLY accept data when this action is sent. |
| open Bundle! |
Get additional metadata carried around with this Action. |
| open Int |
getIcon() |
| open IconCompat? |
Return the icon associated with this Action. |
| open Array<RemoteInput!>! |
Get the list of inputs to be collected from the user when this action is sent. |
| open Int |
Returns the |
| open Boolean |
Return whether or not triggering this |
| open CharSequence! |
getTitle() |
| open Boolean |
Returns whether this is a contextual Action, i. |
Properties |
|
|---|---|
| PendingIntent! |
Intent to send when the user invokes this action. |
| Int |
Small icon representing the action. |
| CharSequence! |
Title of the action. |
Constants
SEMANTIC_ACTION_ARCHIVE
static val SEMANTIC_ACTION_ARCHIVE: Int
SemanticAction: Archive the content associated with the notification. This could mean archiving an email, message, etc.
Value: 5
SEMANTIC_ACTION_CALL
static val SEMANTIC_ACTION_CALL: Int
SemanticAction: Call a contact, group, etc.
Value: 10
SEMANTIC_ACTION_DELETE
static val SEMANTIC_ACTION_DELETE: Int
SemanticAction: Delete the content associated with the notification. This could mean deleting an email, message, etc.
Value: 4
SEMANTIC_ACTION_MARK_AS_READ
static val SEMANTIC_ACTION_MARK_AS_READ: Int
SemanticAction: Mark content as read.
Value: 2
SEMANTIC_ACTION_MARK_AS_UNREAD
static val SEMANTIC_ACTION_MARK_AS_UNREAD: Int
SemanticAction: Mark content as unread.
Value: 3
SEMANTIC_ACTION_MUTE
static val SEMANTIC_ACTION_MUTE: Int
SemanticAction: Mute the content associated with the notification. This could mean silencing a conversation or currently playing media.
Value: 6
SEMANTIC_ACTION_NONE
static val SEMANTIC_ACTION_NONE: Int
SemanticAction: No semantic action defined.
Value: 0
SEMANTIC_ACTION_REPLY
static val SEMANTIC_ACTION_REPLY: Int
SemanticAction: Reply to a conversation, chat, group, or wherever replies may be appropriate.
Value: 1
SEMANTIC_ACTION_THUMBS_DOWN
static val SEMANTIC_ACTION_THUMBS_DOWN: Int
SemanticAction: Mark content with a thumbs down.
Value: 9
SEMANTIC_ACTION_THUMBS_UP
static val SEMANTIC_ACTION_THUMBS_UP: Int
SemanticAction: Mark content with a thumbs up.
Value: 8
SEMANTIC_ACTION_UNMUTE
static val SEMANTIC_ACTION_UNMUTE: Int
SemanticAction: Unmute the content associated with the notification. This could mean un-silencing a conversation or currently playing media.
Value: 7
Public constructors
<init>
Action(icon: Int, title: CharSequence!, intent: PendingIntent!)
<init>
Action(@Nullable icon: IconCompat?, @Nullable title: CharSequence?, @Nullable intent: PendingIntent?)
Note: For devices running an Android version strictly lower than API level 23 this constructor only supports resource-ID based IconCompat objects.
Public methods
getActionIntent
open fun getActionIntent(): PendingIntent!
getAllowGeneratedReplies
open fun getAllowGeneratedReplies(): Boolean
Return whether the platform should automatically generate possible replies for this Action
getDataOnlyRemoteInputs
open 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 RemoteInput#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.
getIconCompat
@Nullable open fun getIconCompat(): IconCompat?
Return the icon associated with this Action.
getRemoteInputs
open 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.
getSemanticAction
open 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).
See Also
getShowsUserInterface
open fun getShowsUserInterface(): Boolean
Return whether or not triggering this Action's PendingIntent will open a user interface.
getTitle
open fun getTitle(): CharSequence!
isContextual
open 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.
Properties
actionIntent
var 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.