Notification.Action

SEMANTIC_ACTION_ARCHIVE

public static final int SEMANTIC_ACTION_ARCHIVE

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

Constant Value: 5 (0x00000005)

SEMANTIC_ACTION_CALL

public static final int SEMANTIC_ACTION_CALL

SemanticAction: Call a contact, group, etc.

Constant Value: 10 (0x0000000a)

SEMANTIC_ACTION_DELETE

public static final int SEMANTIC_ACTION_DELETE

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

Constant Value: 4 (0x00000004)

SEMANTIC_ACTION_MARK_AS_READ

public static final int SEMANTIC_ACTION_MARK_AS_READ

SemanticAction: Mark content as read.

Constant Value: 2 (0x00000002)

SEMANTIC_ACTION_MARK_AS_UNREAD

public static final int SEMANTIC_ACTION_MARK_AS_UNREAD

SemanticAction: Mark content as unread.

Constant Value: 3 (0x00000003)

SEMANTIC_ACTION_MUTE

public static final int SEMANTIC_ACTION_MUTE

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

Constant Value: 6 (0x00000006)

SEMANTIC_ACTION_NONE

public static final int SEMANTIC_ACTION_NONE

No semantic action defined.

Constant Value: 0 (0x00000000)

SEMANTIC_ACTION_REPLY

public static final int SEMANTIC_ACTION_REPLY

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

Constant Value: 1 (0x00000001)

SEMANTIC_ACTION_THUMBS_DOWN

public static final int SEMANTIC_ACTION_THUMBS_DOWN

SemanticAction: Mark content with a thumbs down.

Constant Value: 9 (0x00000009)

SEMANTIC_ACTION_THUMBS_UP

public static final int SEMANTIC_ACTION_THUMBS_UP

SemanticAction: Mark content with a thumbs up.

Constant Value: 8 (0x00000008)

SEMANTIC_ACTION_UNMUTE

public static final int SEMANTIC_ACTION_UNMUTE

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

Constant Value: 7 (0x00000007)

CREATOR

public static final Creator<Notification.Action> CREATOR

actionIntent

public PendingIntent actionIntent

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

icon

public int icon

This field was deprecated in API level 23.
Use Action.getIcon() instead.

Small icon representing the action.

title

public CharSequence title

Title of the action.

Action

public Action (int icon, 
                CharSequence title, 
                PendingIntent intent)

This constructor is deprecated.
Use Notification.Action.Builder.

clone

public Notification.Action clone ()

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

 x.clone().getClass() == x.getClass()

 x.clone().equals(x)

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

describeContents

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.

getAllowGeneratedReplies

public boolean getAllowGeneratedReplies ()

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

getDataOnlyRemoteInputs

public RemoteInput[] getDataOnlyRemoteInputs ()

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.

Returns null if there are no data-only remote inputs.

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

getExtras

public Bundle getExtras ()

Get additional metadata carried around with this Action.

getIcon

public Icon getIcon ()

Return an icon representing the action.

getRemoteInputs

public RemoteInput[] getRemoteInputs ()

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

public int getSemanticAction ()

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

isAuthenticationRequired

public boolean isAuthenticationRequired ()

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.

isContextual

public boolean isContextual ()

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.

writeToParcel

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.