PendingIntent

FLAG_ALLOW_UNSAFE_IMPLICIT_INTENT

public static final int FLAG_ALLOW_UNSAFE_IMPLICIT_INTENT

Flag indicating that the created PendingIntent with FLAG_MUTABLE is allowed to have an unsafe implicit Intent within.

Starting with Build.VERSION_CODES.UPSIDE_DOWN_CAKE, for apps that target SDK Build.VERSION_CODES.UPSIDE_DOWN_CAKE or higher, creation of a PendingIntent with FLAG_MUTABLE and an implicit Intent within will throw an IllegalArgumentException for security reasons. To bypass this check, use FLAG_ALLOW_UNSAFE_IMPLICIT_INTENT when creating a PendingIntent. However, it is strongly recommended to not to use this flag and make the Intent explicit or the PendingIntent immutable, thereby making the Intent safe.

Constant Value: 16777216 (0x01000000)

FLAG_CANCEL_CURRENT

public static final int FLAG_CANCEL_CURRENT

Flag indicating that if the described PendingIntent already exists, the current one should be canceled before generating a new one. For use with getActivity(Context, int, Intent, int), getBroadcast(Context, int, Intent, int), and getService(Context, int, Intent, int).

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.

Constant Value: 268435456 (0x10000000)

FLAG_IMMUTABLE

public static final int FLAG_IMMUTABLE

Flag indicating that the created PendingIntent should be immutable. This means that the additional intent argument passed to the send methods to fill in unpopulated properties of this intent will be ignored.

FLAG_IMMUTABLE only limits the ability to alter the semantics of the intent that is sent by send() by the invoker of send(). The creator of the PendingIntent can always update the PendingIntent itself via FLAG_UPDATE_CURRENT.

Constant Value: 67108864 (0x04000000)

FLAG_MUTABLE

public static final int FLAG_MUTABLE

Flag indicating that the created PendingIntent should be mutable. This flag cannot be combined with FLAG_IMMUTABLE.

Up until Build.VERSION_CODES.R, PendingIntents are assumed to be mutable by default, unless FLAG_IMMUTABLE is set. Starting with Build.VERSION_CODES.S, it will be required to explicitly specify the mutability of PendingIntents on creation with either FLAG_IMMUTABLE or FLAG_MUTABLE. It is strongly recommended to use FLAG_IMMUTABLE when creating a PendingIntent. FLAG_MUTABLE should only be used when some functionality relies on modifying the underlying intent, e.g. any PendingIntent that needs to be used with inline reply or bubbles.

Constant Value: 33554432 (0x02000000)

FLAG_NO_CREATE

public static final int FLAG_NO_CREATE

Flag indicating that if the described PendingIntent does not already exist, then simply return null instead of creating it. For use with getActivity(Context, int, Intent, int), getBroadcast(Context, int, Intent, int), and getService(Context, int, Intent, int).

Constant Value: 536870912 (0x20000000)

FLAG_ONE_SHOT

public static final int FLAG_ONE_SHOT

Flag indicating that this PendingIntent can be used only once. For use with getActivity(Context, int, Intent, int), getBroadcast(Context, int, Intent, int), and getService(Context, int, Intent, int).

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)

FLAG_UPDATE_CURRENT

public static final int FLAG_UPDATE_CURRENT

Flag 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 getActivity(Context, int, Intent, int), getBroadcast(Context, int, Intent, int), and getService(Context, int, Intent, int).

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.

FLAG_UPDATE_CURRENT still works even if FLAG_IMMUTABLE is set - the creator of the PendingIntent can always update the PendingIntent itself. The IMMUTABLE flag only limits the ability to alter the semantics of the intent that is sent by send() by the invoker of send().

Constant Value: 134217728 (0x08000000)

CREATOR

public static final Creator<PendingIntent> CREATOR

cancel

public void cancel ()

Cancel a currently active PendingIntent. Only the original application owning a PendingIntent can cancel it.

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.

equals

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.

getActivities

public static PendingIntent getActivities (Context context, 
                int requestCode, 
                Intent[] intents, 
                int flags, 
                Bundle options)

Like getActivity(android.content.Context, int, android.content.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 getActivity(android.content.Context, int, android.content.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 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 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(android.content.Context, int, android.content.Intent, int), its content will be the subject of replacement by send(android.content.Context, int, android.content.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.

For security reasons, the Intent objects you supply here should almost always be explicit intents, that is specify an explicit component to be delivered to through Intent.setClass

getActivities

public static PendingIntent getActivities (Context context, 
                int requestCode, 
                Intent[] intents, 
                int flags)

Like getActivity(android.content.Context, int, android.content.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 getActivity(android.content.Context, int, android.content.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 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 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(android.content.Context, int, android.content.Intent, int), its content will be the subject of replacement by send(android.content.Context, int, android.content.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.

For security reasons, the Intent objects you supply here should almost always be explicit intents, that is specify an explicit component to be delivered to through Intent.setClass

getActivity

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.

For security reasons, the Intent you supply here should almost always be an explicit intent, that is specify an explicit component to be delivered to through Intent.setClass

getActivity

public static PendingIntent getActivity (Context context, 
                int requestCode, 
                Intent intent, 
                int flags, 
                Bundle options)

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.

For security reasons, the Intent you supply here should almost always be an explicit intent, that is specify an explicit component to be delivered to through Intent.setClass

getBroadcast

public static PendingIntent getBroadcast (Context context, 
                int requestCode, 
                Intent intent, 
                int flags)

Retrieve a PendingIntent that will perform a broadcast, like calling Context.sendBroadcast().

For security reasons, the Intent you supply here should almost always be an explicit intent, that is specify an explicit component to be delivered to through Intent.setClass

getCreatorPackage

public 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 send() call, not who gave you the PendingIntent.

getCreatorUid

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 send() call, not who gave you the PendingIntent.

getCreatorUserHandle

public 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 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 send() call, not who gave you the PendingIntent.

getForegroundService

public static PendingIntent getForegroundService (Context context, 
                int requestCode, 
                Intent intent, 
                int flags)

Retrieve a PendingIntent that will start a foreground service, like calling Context.startForegroundService(). The start arguments given to the service will come from the extras of the Intent.

For security reasons, the Intent you supply here should almost always be an explicit intent, that is specify an explicit component to be delivered to through Intent.setClass

getIntentSender

public IntentSender getIntentSender ()

Retrieve a IntentSender object that wraps the existing sender of the PendingIntent

getService

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.

For security reasons, the Intent you supply here should almost always be an explicit intent, that is specify an explicit component to be delivered to through Intent.setClass

getTargetPackage

public String getTargetPackage ()

This method was deprecated in API level 17.
Renamed to getCreatorPackage().

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isActivity

public boolean isActivity ()

isBroadcast

public boolean isBroadcast ()

isForegroundService

public boolean isForegroundService ()

isImmutable

public boolean isImmutable ()

Check if this PendingIntent is marked with FLAG_IMMUTABLE.

isService

public boolean isService ()

readPendingIntentOrNullFromParcel

public static PendingIntent readPendingIntentOrNullFromParcel (Parcel in)

Convenience function for reading either a PendingIntent or null pointer from a Parcel. You must have previously written the PendingIntent with writePendingIntentOrNullToParcel(PendingIntent, Parcel).

send

public void send (Bundle options)

Perform the operation associated with this PendingIntent, supplying additional options for the operation.

send

public void send (Context context, 
                int code, 
                Intent intent, 
                PendingIntent.OnFinished onFinished, 
                Handler handler, 
                String requiredPermission, 
                Bundle options)

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).

send

public void send ()

Perform the operation associated with this PendingIntent.

send

public void send (Context context, 
                int code, 
                Intent intent, 
                PendingIntent.OnFinished onFinished, 
                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 getActivity(Context, int, Intent, int), getBroadcast(Context, int, Intent, int), or getService(Context, int, Intent, int).

send

public void send (Context context, 
                int code, 
                Intent intent, 
                PendingIntent.OnFinished onFinished, 
                Handler handler, 
                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 getActivity(Context, int, Intent, int), getBroadcast(Context, int, Intent, int), or getService(Context, int, Intent, int).

send

public void send (int code, 
                PendingIntent.OnFinished onFinished, 
                Handler handler)

Perform the operation associated with this PendingIntent, allowing the caller to be notified when the send has completed.

send

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.

send

public void send (int code)

Perform the operation associated with this PendingIntent.

toString

public String toString ()

Returns a string representation of the object.

writePendingIntentOrNullToParcel

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.

writeToParcel

public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.