PendingIntent
public final class PendingIntent
extends Object
implements Parcelable
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)
, getActivities(Context, int, Intent[], int)
, getBroadcast(Context, int, Intent, int)
, and 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: 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 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 Intent.filterEquals
. If you use two Intent objects that are equivalent as per 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 Intent.filterEquals
, or different request code integers supplied to getActivity(Context, int, Intent, int)
, getActivities(Context, int, Intent[], int)
, getBroadcast(Context, int, Intent, int)
, or getService(Context, int, Intent, int)
.
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 FLAG_CANCEL_CURRENT
or FLAG_UPDATE_CURRENT
to either cancel or modify whatever current PendingIntent is associated with the Intent you are supplying.
Summary
Nested classes | |
---|---|
class | 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. |
interface | PendingIntent.OnFinished Callback interface for discovering when a send operation has completed. |
Constants | |
---|---|
int | FLAG_CANCEL_CURRENT Flag indicating that if the described PendingIntent already exists, the current one should be canceled before generating a new one. |
int | FLAG_IMMUTABLE Flag indicating that the created PendingIntent should be immutable. |
int | FLAG_NO_CREATE Flag indicating that if the described PendingIntent does not already exist, then simply return null instead of creating it. |
int | FLAG_ONE_SHOT Flag indicating that this PendingIntent can be used only once. |
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. |
Inherited constants | ||||
---|---|---|---|---|
![]() android.os.Parcelable
|
Fields | |
---|---|
public static final Creator<PendingIntent> | CREATOR
|
Public methods | |
---|---|
void | cancel() Cancel a currently active PendingIntent. |
int | describeContents() Describe the kinds of special objects contained in this Parcelable instance’s marshaled representation. |
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. |
static PendingIntent | getActivities(Context context, int requestCode, Intent[] intents, int flags, Bundle options) Like |
static PendingIntent | getActivities(Context context, int requestCode, Intent[] intents, int flags) Like |
static PendingIntent | getActivity(Context context, int requestCode, Intent intent, int flags) Retrieve a PendingIntent that will start a new activity, like calling |
static PendingIntent | getActivity(Context context, int requestCode, Intent intent, int flags, Bundle options) Retrieve a PendingIntent that will start a new activity, like calling |
static PendingIntent | getBroadcast(Context context, int requestCode, Intent intent, int flags) Retrieve a PendingIntent that will perform a broadcast, like calling |
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. |
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. |
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. |
static PendingIntent | getForegroundService(Context context, int requestCode, Intent intent, int flags) Retrieve a PendingIntent that will start a foreground service, like calling |
IntentSender | getIntentSender() Retrieve a IntentSender object that wraps the existing sender of the PendingIntent |
static PendingIntent | getService(Context context, int requestCode, Intent intent, int flags) Retrieve a PendingIntent that will start a service, like calling |
String | getTargetPackage() This method was deprecated in API level 17. Renamed to |
int | hashCode() Returns a hash code value for the object. |
static PendingIntent | readPendingIntentOrNullFromParcel(Parcel in) Convenience function for reading either a PendingIntent or null pointer from a Parcel. |
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. |
void | send() Perform the operation associated with this PendingIntent. |
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. |
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. |
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. |
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. |
void | send(int code) Perform the operation associated with this PendingIntent. |
String | toString() Returns a string representation of the object. |
static void | writePendingIntentOrNullToParcel(PendingIntent sender, Parcel out) Convenience function for writing either a PendingIntent or null pointer to a Parcel. |
void | writeToParcel(Parcel out, int flags) Flatten this object in to a Parcel. |
<a href="https://developer.android.google.cn/reference/android/os/Parcelable.html">android.os.Parcelable</a>
Inherited methods | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() java.lang.Object
| |||||||||||||||||||||||
![]() From interface
|
abstract int | describeContents() Describe the kinds of special objects contained in this Parcelable instance’s marshaled representation. |
abstract void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Constants
FLAG_CANCEL_CURRENT
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
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.
Constant Value: 67108864 (0x04000000)
FLAG_NO_CREATE
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
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
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.
Constant Value: 134217728 (0x08000000)
Fields
Public methods
cancel
void cancel ()
Cancel a currently active PendingIntent. Only the original application owning a PendingIntent can cancel it.
describeContents
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. |
equals
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 reference object with which to compare. |
Returns | |
---|---|
boolean | true if this object is the same as the obj argument; false otherwise. |
getActivities
PendingIntent getActivities (Context context, int requestCode, Intent[] intents, int flags, Bundle options)
Like 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 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.
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should start the activity. |
requestCode | int : Private request code for the sender |
intents | Intent : Array of Intents of the activities to be launched.This value must never be |
flags | int : May be FLAG_ONE_SHOT , FLAG_NO_CREATE , FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT , FLAG_IMMUTABLE 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. |
options | Bundle
This value may be |
Returns | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getActivities
PendingIntent getActivities (Context context, int requestCode, Intent[] intents, int flags)
Like 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 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.
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should start the activity. |
requestCode | int : Private request code for the sender |
intents | Intent : Array of Intents of the activities to be launched.This value must never be |
flags | int : 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. |
Returns | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getActivity
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should start the activity. |
requestCode | int : Private request code for the sender |
intent | Intent : Intent of the activity to be launched. |
flags | int : 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. |
Returns | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getActivity
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should start the activity. |
requestCode | int : Private request code for the sender |
intent | Intent : Intent of the activity to be launched.This value must never be |
flags | int : 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. |
options | Bundle : Additional options for how the Activity should be started. May be null if there are no options.This value may be |
Returns | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getBroadcast
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should perform the broadcast. |
requestCode | int : Private request code for the sender |
intent | Intent : The Intent to be broadcast. |
flags | int : May be FLAG_ONE_SHOT , FLAG_NO_CREATE , FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT , FLAG_IMMUTABLE 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 | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getCreatorPackage
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.
Returns | |
---|---|
String | The package name of the PendingIntent, or null if there is none associated with it. This value may be |
getCreatorUid
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.
Returns | |
---|---|
int | The uid of the PendingIntent, or -1 if there is none associated with it. |
getCreatorUserHandle
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.
Returns | |
---|---|
UserHandle | The user handle of the PendingIntent, or null if there is none associated with it. This value may be |
getForegroundService
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should start the service. |
requestCode | int : Private request code for the sender |
intent | Intent : An Intent describing the service to be started.This value must never be |
flags | int : May be FLAG_ONE_SHOT , FLAG_NO_CREATE , FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT , FLAG_IMMUTABLE 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 | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getIntentSender
IntentSender getIntentSender ()
Retrieve a IntentSender object that wraps the existing sender of the PendingIntent
Returns | |
---|---|
IntentSender | Returns a IntentSender object that wraps the sender of PendingIntent |
getService
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
Parameters | |
---|---|
context | Context : The Context in which this PendingIntent should start the service. |
requestCode | int : Private request code for the sender |
intent | Intent : An Intent describing the service to be started.This value must never be |
flags | int : May be FLAG_ONE_SHOT , FLAG_NO_CREATE , FLAG_CANCEL_CURRENT , FLAG_UPDATE_CURRENT , FLAG_IMMUTABLE 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 | |
---|---|
PendingIntent | Returns an existing or new PendingIntent matching the given parameters. May return null only if FLAG_NO_CREATE has been supplied. |
getTargetPackage
String getTargetPackage ()
This method was deprecated in API level 17.
Renamed to getCreatorPackage()
.
Returns | |
---|---|
String |
hashCode
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 inequals
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(Object)
method, then calling thehashCode
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(java.lang.Object)
method, then calling thehashCode
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.
As much as is reasonably practical, the hashCode method defined by class Object
does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
Returns | |
---|---|
int | a hash code value for this object. |
readPendingIntentOrNullFromParcel
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)
.
Parameters | |
---|---|
in | Parcel : The Parcel containing the written PendingIntent.This value must never be |
Returns | |
---|---|
PendingIntent | Returns the PendingIntent read from the Parcel, or null if null had been written. This value may be |
send
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)
.
Parameters | |
---|---|
context | Context : The Context of the caller. This may be null if intent is also null. |
code | int : Result code to supply back to the PendingIntent’s target. |
intent | 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. If flag FLAG_IMMUTABLE was set when this pending intent was created, this argument will be ignored.This value may be |
onFinished | PendingIntent.OnFinished : The object to call back on when the send has completed, or null for no callback.This value may be |
handler | Handler : Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process.This value may be |
requiredPermission | String : 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.This value may be |
options | Bundle : Additional options the caller would like to provide to modify the sending behavior. May be built from an ActivityOptions to apply to an activity start.This value may be |
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
send
void send ()
Perform the operation associated with this PendingIntent.
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
send
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)
.
Parameters | |
---|---|
context | Context : The Context of the caller. This may be null if intent is also null. |
code | int : Result code to supply back to the PendingIntent’s target. |
intent | 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. If flag FLAG_IMMUTABLE was set when this pending intent was created, this argument will be ignored.This value may be |
onFinished | PendingIntent.OnFinished : The object to call back on when the send has completed, or null for no callback.This value may be |
handler | Handler : Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process.This value may be |
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
send
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)
.
Parameters | |
---|---|
context | Context : The Context of the caller. This may be null if intent is also null. |
code | int : Result code to supply back to the PendingIntent’s target. |
intent | 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. If flag FLAG_IMMUTABLE was set when this pending intent was created, this argument will be ignored.This value may be |
onFinished | PendingIntent.OnFinished : The object to call back on when the send has completed, or null for no callback.This value may be |
handler | Handler : Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process.This value may be |
requiredPermission | String : 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.This value may be |
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
send
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.
Parameters | |
---|---|
code | int : Result code to supply back to the PendingIntent’s target. |
onFinished | PendingIntent.OnFinished : The object to call back on when the send has completed, or null for no callback.This value may be |
handler | Handler : Handler identifying the thread on which the callback should happen. If null, the callback will happen from the thread pool of the process.This value may be |
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
send
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 | Context : The Context of the caller. |
code | int : Result code to supply back to the PendingIntent’s target. |
intent | Intent : Additional Intent data. See Intent.fillIn() for information on how this is applied to the original Intent. If flag FLAG_IMMUTABLE was set when this pending intent was created, this argument will be ignored.This value may be |
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
send
void send (int code)
Perform the operation associated with this PendingIntent.
Parameters | |
---|---|
code | int : Result code to supply back to the PendingIntent’s target. |
Throws | |
---|---|
PendingIntent.CanceledException | Throws CanceledException if the PendingIntent is no longer allowing more intents to be sent through it. |
toString
String toString ()
Returns a string representation of the object. In general, the toString
method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
‘, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String | a string representation of the object. |
writePendingIntentOrNullToParcel
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 | PendingIntent : The PendingIntent to write, or null.This value may be |
out | Parcel : Where to write the PendingIntent. This value must never be |
writeToParcel
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 . |