android.app
public
final
class
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
Summary
Constants
|
|
|
Value |
|
Creator<PendingIntent> |
CREATOR |
|
|
|
int |
FLAG_CANCEL_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 already exists,
the current one is canceled before generating a new one. |
268435456 |
0x10000000 |
int |
FLAG_NO_CREATE |
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. |
536870912 |
0x20000000 |
int |
FLAG_ONE_SHOT |
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. |
1073741824 |
0x40000000 |
Public Methods
|
|
|
|
|
void |
cancel() |
|
|
|
|
|
int |
describeContents() |
|
|
|
|
|
boolean |
equals(Object otherObj) |
|
|
|
static |
|
PendingIntent |
getActivity(Context context, int requestCode, Intent intent, int flags) |
|
|
|
static |
|
PendingIntent |
getBroadcast(Context context, int requestCode, Intent intent, int flags) |
|
|
|
static |
|
PendingIntent |
getService(Context context, int requestCode, Intent intent, int flags) |
|
|
|
|
|
String |
getTargetPackage() |
|
|
|
|
|
int |
hashCode() |
|
|
|
static |
|
PendingIntent |
readPendingIntentOrNullFromParcel(Parcel in) |
|
|
|
|
|
void |
send(int code) |
|
|
|
|
|
void |
send(Context context, int code, Intent intent) |
|
|
|
|
|
void |
send(int code, PendingIntent.OnFinished onFinished, Handler handler) |
|
|
|
|
|
void |
send(Context context, int code, Intent intent, PendingIntent.OnFinished onFinished, Handler handler) |
|
|
|
|
|
void |
send() |
|
|
|
static |
|
void |
writePendingIntentOrNullToParcel(PendingIntent sender, Parcel out) |
|
|
|
|
|
void |
writeToParcel(Parcel out, int flags) |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Constants
public
static
final
int
FLAG_CANCEL_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 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.
Constant Value:
268435456
(0x10000000)
public
static
final
int
FLAG_NO_CREATE
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.
Constant Value:
536870912
(0x20000000)
public
static
final
int
FLAG_ONE_SHOT
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.
Constant Value:
1073741824
(0x40000000)
Public Methods
public
void
cancel()
Cancel a currently active PendingIntent. Only the original application
owning an PendingIntent can cancel it.
public
int
describeContents()
Describe the kinds of special objects contained in this Parcelable's
marshalled representation.
public
boolean
equals(Object otherObj)
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.
Parameters
otherObj
| Object the object to compare with this object. |
Returns
- boolean
true
if the object is the same as this
object false
if it is different from this object.
public
static
PendingIntent
getActivity(Context context, int requestCode, Intent intent, int flags)
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.
Parameters
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, 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. |
Returns
- Returns an existing or new PendingIntent matching the given
parameters. May return null only if FLAG_NO_CREATE has been
supplied.
public
static
PendingIntent
getBroadcast(Context context, int requestCode, Intent intent, int flags)
Retrieve a PendingIntent that will perform a broadcast, like calling
Context.sendBroadcast().
Parameters
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, 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. |
Returns
- Returns an existing or new PendingIntent matching the given
parameters. May return null only if FLAG_NO_CREATE has been
supplied.
public
static
PendingIntent
getService(Context context, int requestCode, Intent intent, int flags)
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.
Parameters
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, 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. |
Returns
- Returns an existing or new PendingIntent matching the given
parameters. May return null only if FLAG_NO_CREATE has been
supplied.
public
String
getTargetPackage()
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
- The package name of the PendingIntent, or null if there is
none associated with it.
public
int
hashCode()
Returns an integer hash code for the receiver. Any two objects which
answer
true
when passed to
.equals
must
answer the same value for this method.
public
static
PendingIntent
readPendingIntentOrNullFromParcel(Parcel in)
Convenience function for reading either a Messenger or null pointer from
a Parcel. You must have previously written the Messenger with
writePendingIntentOrNullToParcel(PendingIntent, Parcel).
Parameters
in
| The Parcel containing the written Messenger. |
Returns
- Returns the Messenger read from the Parcel, or null if null had
been written.
public
void
send(int code)
Perform the operation associated with this PendingIntent.
Parameters
code
| Result code to supply back to the PendingIntent's target. |
public
void
send(Context context, int code, Intent intent)
Perform the operation associated with this PendingIntent, allowing the
caller to specify information about the Intent to use.
Parameters
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. |
Perform the operation associated with this PendingIntent, allowing the
caller to be notified when the send has completed.
Parameters
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. |
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).
Parameters
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. |
public
void
send()
Perform the operation associated with this PendingIntent.
public
static
void
writePendingIntentOrNullToParcel(PendingIntent sender, Parcel out)
Convenience function for writing either a PendingIntent or null pointer to
a Parcel. You must use this with
readPendingIntentOrNullFromParcel(Parcel)
for later reading it.
Parameters
sender
| The PendingIntent to write, or null. |
out
| Where to write the PendingIntent.
|
public
void
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.