java.lang.Object | |
↳ | android.app.PendingIntent |
A description of an Intent and target action to perform with it. Instances
of this class are created with getActivity(Context, int, Intent, int)
,
getBroadcast(Context, int, Intent, int)
, getService(Context, int, Intent, int)
; the returned object can be
handed to other applications so that they can perform the action you
described on your behalf at a later time.
By giving a PendingIntent to another application, you are granting it the right to perform the operation you have specified as if the other application was yourself (with the same permissions and identity). As such, you should be careful about how you build the PendingIntent: often, for example, the base Intent you supply will have the component name explicitly set to one of your own components, to ensure it is ultimately sent there and nowhere else.
A PendingIntent itself is simply a reference to a token maintained by
the system describing the original data used to retrieve it. This means
that, even if its owning application's process is killed, the
PendingIntent itself will remain usable from other processes that
have been given it. If the creating application later re-retrieves the
same kind of PendingIntent (same operation, same Intent action, data,
categories, and components, and same flags), it will receive a PendingIntent
representing the same token if that is still valid, and can thus call
cancel()
to remove it.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PendingIntent.CanceledException | Exception thrown when trying to send through a PendingIntent that has been canceled or is otherwise no longer able to execute the request. | ||||||||||
PendingIntent.OnFinished | Callback interface for discovering when a send operation has completed. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
android.os.Parcelable
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CREATOR |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Cancel a currently active PendingIntent.
| |||||||||||
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
| |||||||||||
Comparison operator on two PendingIntent objects, such that true
is returned then they both represent the same operation from the
same package.
| |||||||||||
Like
getActivity(Context, int, Intent, int) , but allows an
array of Intents to be supplied. | |||||||||||
Retrieve a PendingIntent that will start a new activity, like calling
Context.startActivity(Intent) . | |||||||||||
Retrieve a PendingIntent that will perform a broadcast, like calling
Context.sendBroadcast() . | |||||||||||
Retrieve a IntentSender object that wraps the existing sender of the PendingIntent
| |||||||||||
Retrieve a PendingIntent that will start a service, like calling
Context.startService() . | |||||||||||
Return the package name of the application that created this
PendingIntent, that is the identity under which you will actually be
sending the Intent.
| |||||||||||
Returns an integer hash code for this object.
| |||||||||||
Convenience function for reading either a Messenger or null pointer from
a Parcel.
| |||||||||||
Perform the operation associated with this PendingIntent.
| |||||||||||
Perform the operation associated with this PendingIntent, allowing the
caller to specify information about the Intent to use and be notified
when the send has completed.
| |||||||||||
Perform the operation associated with this PendingIntent.
| |||||||||||
Perform the operation associated with this PendingIntent, allowing the
caller to specify information about the Intent to use.
| |||||||||||
Perform the operation associated with this PendingIntent, allowing the
caller to be notified when the send has completed.
| |||||||||||
Perform the operation associated with this PendingIntent, allowing the
caller to specify information about the Intent to use and be notified
when the send has completed.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
Convenience function for writing either a PendingIntent or null pointer to
a Parcel.
| |||||||||||
Flatten this object in to a Parcel.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
android.os.Parcelable
|
Flag for use with getActivity(Context, int, Intent, int)
, getBroadcast(Context, int, Intent, int)
, and
getService(Context, int, Intent, int)
: if the described PendingIntent already exists,
the current one is canceled before generating a new one. You can use
this to retrieve a new PendingIntent when you are only changing the
extra data in the Intent; by canceling the previous pending intent,
this ensures that only entities given the new data will be able to
launch it. If this assurance is not an issue, consider
FLAG_UPDATE_CURRENT
.
Flag for use with getActivity(Context, int, Intent, int)
, getBroadcast(Context, int, Intent, int)
, and
getService(Context, int, Intent, int)
: if the described PendingIntent does not already
exist, then simply return null instead of creating it.
Flag for use with getActivity(Context, int, Intent, int)
, getBroadcast(Context, int, Intent, int)
, and
getService(Context, int, Intent, int)
: this
PendingIntent can only be used once. If set, after
send()
is called on it, it will be automatically
canceled for you and any future attempt to send through it will fail.
Flag for use with getActivity(Context, int, Intent, int)
, getBroadcast(Context, int, Intent, int)
, and
getService(Context, int, Intent, int)
: if the described PendingIntent already exists,
then keep it but its replace its extra data with what is in this new
Intent. This can be used if you are creating intents where only the
extras change, and don't care that any entities that received your
previous PendingIntent will be able to launch it with your new
extras even if they are not explicitly given to it.
Cancel a currently active PendingIntent. Only the original application owning an PendingIntent can cancel it.
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
Comparison operator on two PendingIntent objects, such that true
is returned then they both represent the same operation from the
same package. This allows you to use getActivity(Context, int, Intent, int)
,
getBroadcast(Context, int, Intent, int)
, or getService(Context, int, Intent, int)
multiple times (even
across a process being killed), resulting in different PendingIntent
objects but whose equals() method identifies them as being the same
operation.
otherObj | the object to compare this instance with. |
---|
true
if the specified object is equal to this Object
; false
otherwise.Like getActivity(Context, int, Intent, int)
, but allows an
array of Intents to be supplied. The first Intent in the array is
taken as the primary key for the PendingIntent, like the single Intent
given to getActivity(Context, int, Intent, int)
. Upon sending
the resulting PendingIntent, all of the Intents are started in the same
way as they would be by passing them to startActivities(Intent[])
.
The first intent in the array will be started outside of the context of an
existing activity, so you must use the Intent.FLAG_ACTIVITY_NEW_TASK
launch flag in the Intent. (Activities after
the first in the array are started in the context of the previous activity
in the array, so FLAG_ACTIVITY_NEW_TASK is not needed nor desired for them.)
The last intent in the array represents the key for the
PendingIntent. In other words, it is the significant element for matching
(as done with the single intent given to getActivity(Context, int, Intent, int)
,
its content will be the subject of replacement by
send(Context, int, Intent)
and FLAG_UPDATE_CURRENT
, etc.
This is because it is the most specific of the supplied intents, and the
UI the user actually sees when the intents are started.
context | The Context in which this PendingIntent should start the activity. |
---|---|
requestCode | Private request code for the sender (currently not used). |
intents | Array of Intents of the activities to be launched. |
flags | May be FLAG_ONE_SHOT , FLAG_NO_CREATE ,
FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT ,
or any of the flags as supported by
Intent.fillIn() to control which unspecified parts
of the intent that can be supplied when the actual send happens. |
FLAG_NO_CREATE
has been
supplied.
Retrieve a PendingIntent that will start a new activity, like calling
Context.startActivity(Intent)
.
Note that the activity will be started outside of the context of an
existing activity, so you must use the Intent.FLAG_ACTIVITY_NEW_TASK
launch flag in the Intent.
context | The Context in which this PendingIntent should start the activity. |
---|---|
requestCode | Private request code for the sender (currently not used). |
intent | Intent of the activity to be launched. |
flags | May be FLAG_ONE_SHOT , FLAG_NO_CREATE ,
FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT ,
or any of the flags as supported by
Intent.fillIn() to control which unspecified parts
of the intent that can be supplied when the actual send happens. |
FLAG_NO_CREATE
has been
supplied.
Retrieve a PendingIntent that will perform a broadcast, like calling
Context.sendBroadcast()
.
context | The Context in which this PendingIntent should perform the broadcast. |
---|---|
requestCode | Private request code for the sender (currently not used). |
intent | The Intent to be broadcast. |
flags | May be FLAG_ONE_SHOT , FLAG_NO_CREATE ,
FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT ,
or any of the flags as supported by
Intent.fillIn() to control which unspecified parts
of the intent that can be supplied when the actual send happens. |
FLAG_NO_CREATE
has been
supplied.
Retrieve a IntentSender object that wraps the existing sender of the PendingIntent
Retrieve a PendingIntent that will start a service, like calling
Context.startService()
. The start
arguments given to the service will come from the extras of the Intent.
context | The Context in which this PendingIntent should start the service. |
---|---|
requestCode | Private request code for the sender (currently not used). |
intent | An Intent describing the service to be started. |
flags | May be FLAG_ONE_SHOT , FLAG_NO_CREATE ,
FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT ,
or any of the flags as supported by
Intent.fillIn() to control which unspecified parts
of the intent that can be supplied when the actual send happens. |
FLAG_NO_CREATE
has been
supplied.
Return the package name of the application that created this PendingIntent, that is the identity under which you will actually be sending the Intent. The returned string is supplied by the system, so that an application can not spoof its package.
Returns an integer hash code for this object. By contract, any two
objects for which equals(Object)
returns true
must return
the same hash code value. This means that subclasses of Object
usually override both methods or neither method.
Note that hash values must not change over time unless information used in equals comparisons also changes.
See Writing a correct
hashCode
method
if you intend implementing your own hashCode
method.
Convenience function for reading either a Messenger or null pointer from
a Parcel. You must have previously written the Messenger with
writePendingIntentOrNullToParcel(PendingIntent, Parcel)
.
in | The Parcel containing the written Messenger. |
---|
Perform the operation associated with this PendingIntent.
code | Result code to supply back to the PendingIntent's target. |
---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
---|
Perform the operation associated with this PendingIntent, allowing the caller to specify information about the Intent to use and be notified when the send has completed.
For the intent parameter, a PendingIntent
often has restrictions on which fields can be supplied here, based on
how the PendingIntent was retrieved in getActivity(Context, int, Intent, int)
,
getBroadcast(Context, int, Intent, int)
, or getService(Context, int, Intent, int)
.
context | The Context of the caller. This may be null if intent is also null. |
---|---|
code | Result code to supply back to the PendingIntent's target. |
intent | Additional Intent data. See Intent.fillIn() for information on how this is applied to the
original Intent. Use null to not modify the original Intent. |
onFinished | The object to call back on when the send has completed, or null for no callback. |
handler | Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process. |
requiredPermission | Name of permission that a recipient of the PendingIntent
is required to hold. This is only valid for broadcast intents, and
corresponds to the permission argument in
Context.sendOrderedBroadcast(Intent, String) .
If null, no permission is required. |
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
---|
Perform the operation associated with this PendingIntent.
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
---|
Perform the operation associated with this PendingIntent, allowing the caller to specify information about the Intent to use.
context | The Context of the caller. |
---|---|
code | Result code to supply back to the PendingIntent's target. |
intent | Additional Intent data. See Intent.fillIn() for information on how this is applied to the
original Intent. |
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
---|
Perform the operation associated with this PendingIntent, allowing the caller to be notified when the send has completed.
code | Result code to supply back to the PendingIntent's target. |
---|---|
onFinished | The object to call back on when the send has completed, or null for no callback. |
handler | Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process. |
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
---|
Perform the operation associated with this PendingIntent, allowing the caller to specify information about the Intent to use and be notified when the send has completed.
For the intent parameter, a PendingIntent
often has restrictions on which fields can be supplied here, based on
how the PendingIntent was retrieved in getActivity(Context, int, Intent, int)
,
getBroadcast(Context, int, Intent, int)
, or getService(Context, int, Intent, int)
.
context | The Context of the caller. This may be null if intent is also null. |
---|---|
code | Result code to supply back to the PendingIntent's target. |
intent | Additional Intent data. See Intent.fillIn() for information on how this is applied to the
original Intent. Use null to not modify the original Intent. |
onFinished | The object to call back on when the send has completed, or null for no callback. |
handler | Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process. |
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
---|
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString
method
if you intend implementing your own toString
method.
Convenience function for writing either a PendingIntent or null pointer to
a Parcel. You must use this with readPendingIntentOrNullFromParcel(Parcel)
for later reading it.
sender | The PendingIntent to write, or null. |
---|---|
out | Where to write the PendingIntent. |
Flatten this object in to a Parcel.
out | The Parcel in which the object should be written. |
---|---|
flags | Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE .
|