PendingIntentpublic final class PendingIntent extends Object implements android.os.ParcelableA description of an Intent and target action to perform with it. Instances
of this class are created with {@link #getActivity}, {@link #getActivities},
{@link #getBroadcast}, and {@link #getService}; 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:
almost always, for example, the base Intent you supply should 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
{@link #cancel} to remove it.
Because of this behavior, it is important to know when two Intents
are considered to be the same for purposes of retrieving a PendingIntent.
A common mistake people make is to create multiple PendingIntent objects
with Intents that only vary in their "extra" contents, expecting to get
a different PendingIntent each time. This does not happen. The
parts of the Intent that are used for matching are the same ones defined
by {@link Intent#filterEquals(Intent) Intent.filterEquals}. If you use two
Intent objects that are equivalent as per
{@link Intent#filterEquals(Intent) Intent.filterEquals}, then you will get
the same PendingIntent for both of them.
There are two typical ways to deal with this.
If you truly need multiple distinct PendingIntent objects active at
the same time (such as to use as two notifications that are both shown
at the same time), then you will need to ensure there is something that
is different about them to associate them with different PendingIntents.
This may be any of the Intent attributes considered by
{@link Intent#filterEquals(Intent) Intent.filterEquals}, or different
request code integers supplied to {@link #getActivity}, {@link #getActivities},
{@link #getBroadcast}, or {@link #getService}.
If you only need one PendingIntent active at a time for any of the
Intents you will use, then you can alternatively use the flags
{@link #FLAG_CANCEL_CURRENT} or {@link #FLAG_UPDATE_CURRENT} to either
cancel or modify whatever current PendingIntent is associated with the
Intent you are supplying. |
Fields Summary |
---|
private final android.content.IIntentSender | mTarget | public static final int | FLAG_ONE_SHOTFlag indicating that this PendingIntent can be used only once.
For use with {@link #getActivity}, {@link #getBroadcast}, and
{@link #getService}. If set, after
{@link #send()} is called on it, it will be automatically
canceled for you and any future attempt to send through it will fail. | public static final int | FLAG_NO_CREATEFlag indicating that if the described PendingIntent does not
already exist, then simply return null instead of creating it.
For use with {@link #getActivity}, {@link #getBroadcast}, and
{@link #getService}. | public static final int | FLAG_CANCEL_CURRENTFlag indicating that if the described PendingIntent already exists,
the current one should be canceled before generating a new one.
For use with {@link #getActivity}, {@link #getBroadcast}, and
{@link #getService}. 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
{@link #FLAG_UPDATE_CURRENT}. | public static final int | FLAG_UPDATE_CURRENTFlag indicating that if the described PendingIntent already exists,
then keep it but replace its extra data with what is in this new
Intent. For use with {@link #getActivity}, {@link #getBroadcast}, and
{@link #getService}. 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. | public static final Parcelable.Creator | CREATOR |
Methods Summary |
---|
public void | cancel()Cancel a currently active PendingIntent. Only the original application
owning a PendingIntent can cancel it.
try {
ActivityManagerNative.getDefault().cancelIntentSender(mTarget);
} catch (RemoteException e) {
}
| public int | describeContents()
return 0;
| public boolean | equals(java.lang.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 {@link #getActivity},
{@link #getBroadcast}, or {@link #getService} multiple times (even
across a process being killed), resulting in different PendingIntent
objects but whose equals() method identifies them as being the same
operation.
if (otherObj instanceof PendingIntent) {
return mTarget.asBinder().equals(((PendingIntent)otherObj)
.mTarget.asBinder());
}
return false;
| public static android.app.PendingIntent | getActivities(android.content.Context context, int requestCode, android.content.Intent[] intents, int flags)Like {@link #getActivity(Context, int, Intent, int)}, but allows an
array of Intents to be supplied. The last Intent in the array is
taken as the primary key for the PendingIntent, like the single Intent
given to {@link #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 {@link Context#startActivities(Intent[])}.
The first intent in the array will be started outside of the context of an
existing activity, so you must use the {@link Intent#FLAG_ACTIVITY_NEW_TASK
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 {@link #getActivity(Context, int, Intent, int)},
its content will be the subject of replacement by
{@link #send(Context, int, Intent)} and {@link #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.
For security reasons, the {@link android.content.Intent} objects
you supply here should almost always be explicit intents,
that is specify an explicit component to be delivered to through
{@link Intent#setClass(android.content.Context, Class) Intent.setClass}
return getActivities(context, requestCode, intents, flags, null);
| public static android.app.PendingIntent | getActivities(android.content.Context context, int requestCode, android.content.Intent[] intents, int flags, android.os.Bundle options)Like {@link #getActivity(Context, int, Intent, int)}, but allows an
array of Intents to be supplied. The last Intent in the array is
taken as the primary key for the PendingIntent, like the single Intent
given to {@link #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 {@link Context#startActivities(Intent[])}.
The first intent in the array will be started outside of the context of an
existing activity, so you must use the {@link Intent#FLAG_ACTIVITY_NEW_TASK
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 {@link #getActivity(Context, int, Intent, int)},
its content will be the subject of replacement by
{@link #send(Context, int, Intent)} and {@link #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.
For security reasons, the {@link android.content.Intent} objects
you supply here should almost always be explicit intents,
that is specify an explicit component to be delivered to through
{@link Intent#setClass(android.content.Context, Class) Intent.setClass}
String packageName = context.getPackageName();
String[] resolvedTypes = new String[intents.length];
for (int i=0; i<intents.length; i++) {
intents[i].migrateExtraStreamToClipData();
intents[i].prepareToLeaveProcess();
resolvedTypes[i] = intents[i].resolveTypeIfNeeded(context.getContentResolver());
}
try {
IIntentSender target =
ActivityManagerNative.getDefault().getIntentSender(
ActivityManager.INTENT_SENDER_ACTIVITY, packageName,
null, null, requestCode, intents, resolvedTypes, flags, options,
UserHandle.myUserId());
return target != null ? new PendingIntent(target) : null;
} catch (RemoteException e) {
}
return null;
| public static android.app.PendingIntent | getActivitiesAsUser(android.content.Context context, int requestCode, android.content.Intent[] intents, int flags, android.os.Bundle options, android.os.UserHandle user)
String packageName = context.getPackageName();
String[] resolvedTypes = new String[intents.length];
for (int i=0; i<intents.length; i++) {
intents[i].migrateExtraStreamToClipData();
intents[i].prepareToLeaveProcess();
resolvedTypes[i] = intents[i].resolveTypeIfNeeded(context.getContentResolver());
}
try {
IIntentSender target =
ActivityManagerNative.getDefault().getIntentSender(
ActivityManager.INTENT_SENDER_ACTIVITY, packageName,
null, null, requestCode, intents, resolvedTypes,
flags, options, user.getIdentifier());
return target != null ? new PendingIntent(target) : null;
} catch (RemoteException e) {
}
return null;
| public static android.app.PendingIntent | getActivity(android.content.Context context, int requestCode, android.content.Intent intent, int flags)Retrieve a PendingIntent that will start a new activity, like calling
{@link Context#startActivity(Intent) Context.startActivity(Intent)}.
Note that the activity will be started outside of the context of an
existing activity, so you must use the {@link Intent#FLAG_ACTIVITY_NEW_TASK
Intent.FLAG_ACTIVITY_NEW_TASK} launch flag in the Intent.
For security reasons, the {@link android.content.Intent}
you supply here should almost always be an explicit intent,
that is specify an explicit component to be delivered to through
{@link Intent#setClass(android.content.Context, Class) Intent.setClass}
return getActivity(context, requestCode, intent, flags, null);
| public static android.app.PendingIntent | getActivity(android.content.Context context, int requestCode, android.content.Intent intent, int flags, android.os.Bundle options)Retrieve a PendingIntent that will start a new activity, like calling
{@link Context#startActivity(Intent) Context.startActivity(Intent)}.
Note that the activity will be started outside of the context of an
existing activity, so you must use the {@link Intent#FLAG_ACTIVITY_NEW_TASK
Intent.FLAG_ACTIVITY_NEW_TASK} launch flag in the Intent.
For security reasons, the {@link android.content.Intent}
you supply here should almost always be an explicit intent,
that is specify an explicit component to be delivered to through
{@link Intent#setClass(android.content.Context, Class) Intent.setClass}
String packageName = context.getPackageName();
String resolvedType = intent != null ? intent.resolveTypeIfNeeded(
context.getContentResolver()) : null;
try {
intent.migrateExtraStreamToClipData();
intent.prepareToLeaveProcess();
IIntentSender target =
ActivityManagerNative.getDefault().getIntentSender(
ActivityManager.INTENT_SENDER_ACTIVITY, packageName,
null, null, requestCode, new Intent[] { intent },
resolvedType != null ? new String[] { resolvedType } : null,
flags, options, UserHandle.myUserId());
return target != null ? new PendingIntent(target) : null;
} catch (RemoteException e) {
}
return null;
| public static android.app.PendingIntent | getActivityAsUser(android.content.Context context, int requestCode, android.content.Intent intent, int flags, android.os.Bundle options, android.os.UserHandle user)
String packageName = context.getPackageName();
String resolvedType = intent != null ? intent.resolveTypeIfNeeded(
context.getContentResolver()) : null;
try {
intent.migrateExtraStreamToClipData();
intent.prepareToLeaveProcess();
IIntentSender target =
ActivityManagerNative.getDefault().getIntentSender(
ActivityManager.INTENT_SENDER_ACTIVITY, packageName,
null, null, requestCode, new Intent[] { intent },
resolvedType != null ? new String[] { resolvedType } : null,
flags, options, user.getIdentifier());
return target != null ? new PendingIntent(target) : null;
} catch (RemoteException e) {
}
return null;
| public static android.app.PendingIntent | getBroadcast(android.content.Context context, int requestCode, android.content.Intent intent, int flags)Retrieve a PendingIntent that will perform a broadcast, like calling
{@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
For security reasons, the {@link android.content.Intent}
you supply here should almost always be an explicit intent,
that is specify an explicit component to be delivered to through
{@link Intent#setClass(android.content.Context, Class) Intent.setClass}
return getBroadcastAsUser(context, requestCode, intent, flags,
new UserHandle(UserHandle.myUserId()));
| public static android.app.PendingIntent | getBroadcastAsUser(android.content.Context context, int requestCode, android.content.Intent intent, int flags, android.os.UserHandle userHandle)
String packageName = context.getPackageName();
String resolvedType = intent != null ? intent.resolveTypeIfNeeded(
context.getContentResolver()) : null;
try {
intent.prepareToLeaveProcess();
IIntentSender target =
ActivityManagerNative.getDefault().getIntentSender(
ActivityManager.INTENT_SENDER_BROADCAST, packageName,
null, null, requestCode, new Intent[] { intent },
resolvedType != null ? new String[] { resolvedType } : null,
flags, null, userHandle.getIdentifier());
return target != null ? new PendingIntent(target) : null;
} catch (RemoteException e) {
}
return null;
| public java.lang.String | getCreatorPackage()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.
Be careful about how you use this. All this tells you is
who created the PendingIntent. It does not tell you who
handed the PendingIntent to you: that is, PendingIntent objects are intended to be
passed between applications, so the PendingIntent you receive from an application
could actually be one it received from another application, meaning the result
you get here will identify the original application. Because of this, you should
only use this information to identify who you expect to be interacting with
through a {@link #send} call, not who gave you the PendingIntent.
try {
return ActivityManagerNative.getDefault()
.getPackageForIntentSender(mTarget);
} catch (RemoteException e) {
// Should never happen.
return null;
}
| public int | getCreatorUid()Return the uid of the application that created this
PendingIntent, that is the identity under which you will actually be
sending the Intent. The returned integer is supplied by the system, so
that an application can not spoof its uid.
Be careful about how you use this. All this tells you is
who created the PendingIntent. It does not tell you who
handed the PendingIntent to you: that is, PendingIntent objects are intended to be
passed between applications, so the PendingIntent you receive from an application
could actually be one it received from another application, meaning the result
you get here will identify the original application. Because of this, you should
only use this information to identify who you expect to be interacting with
through a {@link #send} call, not who gave you the PendingIntent.
try {
return ActivityManagerNative.getDefault()
.getUidForIntentSender(mTarget);
} catch (RemoteException e) {
// Should never happen.
return -1;
}
| public android.os.UserHandle | getCreatorUserHandle()Return the user handle of the application that created this
PendingIntent, that is the user under which you will actually be
sending the Intent. The returned UserHandle is supplied by the system, so
that an application can not spoof its user. See
{@link android.os.Process#myUserHandle() Process.myUserHandle()} for
more explanation of user handles.
Be careful about how you use this. All this tells you is
who created the PendingIntent. It does not tell you who
handed the PendingIntent to you: that is, PendingIntent objects are intended to be
passed between applications, so the PendingIntent you receive from an application
could actually be one it received from another application, meaning the result
you get here will identify the original application. Because of this, you should
only use this information to identify who you expect to be interacting with
through a {@link #send} call, not who gave you the PendingIntent.
try {
int uid = ActivityManagerNative.getDefault()
.getUidForIntentSender(mTarget);
return uid > 0 ? new UserHandle(UserHandle.getUserId(uid)) : null;
} catch (RemoteException e) {
// Should never happen.
return null;
}
| public android.content.Intent | getIntent()
try {
return ActivityManagerNative.getDefault()
.getIntentForIntentSender(mTarget);
} catch (RemoteException e) {
// Should never happen.
return null;
}
| public android.content.IntentSender | getIntentSender()Retrieve a IntentSender object that wraps the existing sender of the PendingIntent
return new IntentSender(mTarget);
| public static android.app.PendingIntent | getService(android.content.Context context, int requestCode, android.content.Intent intent, int flags)Retrieve a PendingIntent that will start a service, like calling
{@link Context#startService Context.startService()}. The start
arguments given to the service will come from the extras of the Intent.
For security reasons, the {@link android.content.Intent}
you supply here should almost always be an explicit intent,
that is specify an explicit component to be delivered to through
{@link Intent#setClass(android.content.Context, Class) Intent.setClass}
String packageName = context.getPackageName();
String resolvedType = intent != null ? intent.resolveTypeIfNeeded(
context.getContentResolver()) : null;
try {
intent.prepareToLeaveProcess();
IIntentSender target =
ActivityManagerNative.getDefault().getIntentSender(
ActivityManager.INTENT_SENDER_SERVICE, packageName,
null, null, requestCode, new Intent[] { intent },
resolvedType != null ? new String[] { resolvedType } : null,
flags, null, UserHandle.myUserId());
return target != null ? new PendingIntent(target) : null;
} catch (RemoteException e) {
}
return null;
| public java.lang.String | getTag(java.lang.String prefix)
try {
return ActivityManagerNative.getDefault()
.getTagForIntentSender(mTarget, prefix);
} catch (RemoteException e) {
// Should never happen.
return null;
}
| public android.content.IIntentSender | getTarget()
return mTarget;
| public java.lang.String | getTargetPackage()
try {
return ActivityManagerNative.getDefault()
.getPackageForIntentSender(mTarget);
} catch (RemoteException e) {
// Should never happen.
return null;
}
| public int | hashCode()
return mTarget.asBinder().hashCode();
| public boolean | isActivity()
try {
return ActivityManagerNative.getDefault()
.isIntentSenderAnActivity(mTarget);
} catch (RemoteException e) {
// Should never happen.
return false;
}
| public boolean | isTargetedToPackage()
try {
return ActivityManagerNative.getDefault()
.isIntentSenderTargetedToPackage(mTarget);
} catch (RemoteException e) {
// Should never happen.
return false;
}
| public static android.app.PendingIntent | readPendingIntentOrNullFromParcel(android.os.Parcel in)Convenience function for reading either a Messenger or null pointer from
a Parcel. You must have previously written the Messenger with
{@link #writePendingIntentOrNullToParcel}.
IBinder b = in.readStrongBinder();
return b != null ? new PendingIntent(b) : null;
| public void | send()Perform the operation associated with this PendingIntent.
send(null, 0, null, null, null, null);
| public void | send(int code)Perform the operation associated with this PendingIntent.
send(null, code, null, null, null, null);
| public void | send(android.content.Context context, int code, android.content.Intent intent)Perform the operation associated with this PendingIntent, allowing the
caller to specify information about the Intent to use.
send(context, code, intent, null, null, null);
| public void | send(int code, android.app.PendingIntent$OnFinished onFinished, android.os.Handler handler)Perform the operation associated with this PendingIntent, allowing the
caller to be notified when the send has completed.
send(null, code, null, onFinished, handler, null);
| public void | send(android.content.Context context, int code, android.content.Intent intent, android.app.PendingIntent$OnFinished onFinished, android.os.Handler handler)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 {@link #getActivity},
{@link #getBroadcast}, or {@link #getService}.
send(context, code, intent, onFinished, handler, null);
| public void | send(android.content.Context context, int code, android.content.Intent intent, android.app.PendingIntent$OnFinished onFinished, android.os.Handler handler, java.lang.String requiredPermission)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 {@link #getActivity},
{@link #getBroadcast}, or {@link #getService}.
try {
String resolvedType = intent != null ?
intent.resolveTypeIfNeeded(context.getContentResolver())
: null;
int res = mTarget.send(code, intent, resolvedType,
onFinished != null
? new FinishedDispatcher(this, onFinished, handler)
: null,
requiredPermission);
if (res < 0) {
throw new CanceledException();
}
} catch (RemoteException e) {
throw new CanceledException(e);
}
| public java.lang.String | toString()
StringBuilder sb = new StringBuilder(128);
sb.append("PendingIntent{");
sb.append(Integer.toHexString(System.identityHashCode(this)));
sb.append(": ");
sb.append(mTarget != null ? mTarget.asBinder() : null);
sb.append('}");
return sb.toString();
| public static void | writePendingIntentOrNullToParcel(android.app.PendingIntent sender, android.os.Parcel out)Convenience function for writing either a PendingIntent or null pointer to
a Parcel. You must use this with {@link #readPendingIntentOrNullFromParcel}
for later reading it.
out.writeStrongBinder(sender != null ? sender.mTarget.asBinder()
: null);
| public void | writeToParcel(android.os.Parcel out, int flags)
out.writeStrongBinder(mTarget.asBinder());
|
|