Skip to content

Most visited

Recently visited

navigation

IntentSender

public class IntentSender
extends Object implements Parcelable

java.lang.Object
   ↳ android.content.IntentSender


A description of an Intent and target action to perform with it. 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 IntentSender 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 IntentSender: 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 IntentSender 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 IntentSender itself will remain usable from other processes that have been given it. If the creating application later re-retrieves the same kind of IntentSender (same operation, same Intent action, data, categories, and components, and same flags), it will receive a IntentSender representing the same token if that is still valid.

Instances of this class can not be made directly, but rather must be created from an existing PendingIntent with PendingIntent.getIntentSender().

Summary

Nested classes

interface IntentSender.OnFinished

Callback interface for discovering when a send operation has completed. 

class IntentSender.SendIntentException

Exception thrown when trying to send through a PendingIntent that has been canceled or is otherwise no longer able to execute the request. 

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<IntentSender> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object otherObj)

Comparison operator on two IntentSender objects, such that true is returned then they both represent the same operation from the same package.

String getCreatorPackage()

Return the package name of the application that created this IntentSender, 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.

String getTargetPackage()

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

int hashCode()

Returns a hash code value for the object.

static IntentSender readIntentSenderOrNullFromParcel(Parcel in)

Convenience function for reading either a Messenger or null pointer from a Parcel.

void sendIntent(Context context, int code, Intent intent, IntentSender.OnFinished onFinished, Handler handler)

Perform the operation associated with this IntentSender, allowing the caller to specify information about the Intent to use and be notified when the send has completed.

void sendIntent(Context context, int code, Intent intent, IntentSender.OnFinished onFinished, Handler handler, String requiredPermission)

Perform the operation associated with this IntentSender, allowing the caller to specify information about the Intent to use and be notified when the send has completed.

String toString()

Returns a string representation of the object.

static void writeIntentSenderOrNullToParcel(IntentSender sender, Parcel out)

Convenience function for writing either a IntentSender or null pointer to a Parcel.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 4
Creator<IntentSender> CREATOR

Public methods

describeContents

Added in API level 4
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

Added in API level 4
boolean equals (Object otherObj)

Comparison operator on two IntentSender objects, such that true is returned then they both represent the same operation from the same package.

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.

getCreatorPackage

Added in API level 17
String getCreatorPackage ()

Return the package name of the application that created this IntentSender, 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
String The package name of the PendingIntent, or null if there is none associated with it.

getCreatorUid

Added in API level 17
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.

Returns
int The uid of the PendingIntent, or -1 if there is none associated with it.

getCreatorUserHandle

Added in API level 17
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.

Returns
UserHandle The user handle of the PendingIntent, or null if there is none associated with it.

getTargetPackage

Added in API level 9
String getTargetPackage ()

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

Returns
String

hashCode

Added in API level 4
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(Object) 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(java.lang.Object) 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.

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 JavaTM programming language.)

Returns
int a hash code value for this object.

readIntentSenderOrNullFromParcel

Added in API level 4
IntentSender readIntentSenderOrNullFromParcel (Parcel in)

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

Parameters
in Parcel: The Parcel containing the written Messenger.
Returns
IntentSender Returns the Messenger read from the Parcel, or null if null had been written.

sendIntent

Added in API level 4
void sendIntent (Context context, 
                int code, 
                Intent intent, 
                IntentSender.OnFinished onFinished, 
                Handler handler)

Perform the operation associated with this IntentSender, allowing the caller to specify information about the Intent to use and be notified when the send has completed.

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 IntentSender'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.
onFinished IntentSender.OnFinished: The object to call back on when the send has completed, or null for no callback.
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.
Throws
IntentSender.SendIntentException Throws CanceledIntentException if the IntentSender is no longer allowing more intents to be sent through it.

sendIntent

Added in API level 14
void sendIntent (Context context, 
                int code, 
                Intent intent, 
                IntentSender.OnFinished onFinished, 
                Handler handler, 
                String requiredPermission)

Perform the operation associated with this IntentSender, allowing the caller to specify information about the Intent to use and be notified when the send has completed.

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 IntentSender'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.
onFinished IntentSender.OnFinished: The object to call back on when the send has completed, or null for no callback.
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.
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.
Throws
IntentSender.SendIntentException Throws CanceledIntentException if the IntentSender is no longer allowing more intents to be sent through it.

toString

Added in API level 4
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.

writeIntentSenderOrNullToParcel

Added in API level 4
void writeIntentSenderOrNullToParcel (IntentSender sender, 
                Parcel out)

Convenience function for writing either a IntentSender or null pointer to a Parcel. You must use this with readIntentSenderOrNullFromParcel(Parcel) for later reading it.

Parameters
sender IntentSender: The IntentSender to write, or null.
out Parcel: Where to write the IntentSender.

writeToParcel

Added in API level 4
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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.