public
static
class
Notification.Action
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.app.Notification.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.
Apps should use addAction(int, CharSequence, PendingIntent)
or addAction(Notification.Action)
to attach actions.
Nested classes | |
|---|---|
class |
Notification.Action.Builder
Builder class for |
interface |
Notification.Action.Extender
Extender interface for use with |
class |
Notification.Action.WearableExtender
Wearable extender for notification actions. |
Inherited constants |
|---|
 From
interface
android.os.Parcelable
|
Fields | |
|---|---|
public
static
final
Creator<Notification.Action> |
CREATOR
|
public
PendingIntent |
actionIntent
Intent to send when the user invokes this action. |
public
int |
icon
This field was deprecated
in API level 23.
Use |
public
CharSequence |
title
Title of the action. |
Public constructors | |
|---|---|
Notification.Action(int icon, CharSequence title, PendingIntent intent)
This constructor was deprecated
in API level 23.
Use |
|
Public methods | |
|---|---|
Notification.Action
|
clone()
Creates and returns a copy of this object. |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
getAllowGeneratedReplies()
Return whether the platform should automatically generate possible replies for this
|
Bundle
|
getExtras()
Get additional metadata carried around with this Action. |
Icon
|
getIcon()
Return an icon representing the action. |
RemoteInput[]
|
getRemoteInputs()
Get the list of inputs to be collected from the user when this action is sent. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
| |
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.
int icon
This field was deprecated
in API level 23.
Use getIcon() instead.
Small icon representing the action.
Developers
Notification.Action (int icon,
CharSequence title,
PendingIntent intent)
This constructor was deprecated
in API level 23.
Use Notification.Action.Builder.
| Parameters | |
|---|---|
icon |
int
|
title |
CharSequence
|
intent |
PendingIntent
|
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:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true, this is not an absolute requirement.
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.
The method clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
| Returns | |
|---|---|
Notification.Action |
a clone of this instance. |
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(Parcel, int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
| Returns | |
|---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
boolean getAllowGeneratedReplies ()
Return whether the platform should automatically generate possible replies for this
Notification.Action
| Returns | |
|---|---|
boolean |
|
Bundle getExtras ()
Get additional metadata carried around with this Action.
| Returns | |
|---|---|
Bundle |
|
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.
| Returns | |
|---|---|
RemoteInput[] |
|
void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
out |
Parcel:
The Parcel in which the object should be written. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|