Added in API level 4

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

IntentSender

Kotlin |Java

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

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout 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, String requiredPermission, Bundle options, Executor executor, IntentSender.OnFinished onFinished)` 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)` 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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

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

Fields

CREATOR

Added in API level 4

public static final Creator<IntentSender> CREATOR

Public methods

describeContents

Added in API level 4

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.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 4

public 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`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCreatorPackage

Added in API level 17

public 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

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.

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

getCreatorUserHandle

Added in API level 17

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.

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

getTargetPackage

Added in API level 9
Deprecated in API level 17

public String getTargetPackage ()

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

Returns
`String`

hashCode

Added in API level 4

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.

Returns
`int`	a hash code value for this object.

readIntentSenderOrNullFromParcel

Added in API level 4

public static 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 @code null} if @code null} had been written.

sendIntent

Added in Android Baklava

public void sendIntent (Context context, 
                int code, 
                Intent intent, 
                String requiredPermission, 
                Bundle options, 
                Executor executor, 
                IntentSender.OnFinished onFinished)

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.
`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.
`options`	`Bundle`: Additional options the caller would like to provide to modify the sending behavior. Typically built from using `ActivityOptions` to apply to an activity start. This value may be `null`.
`executor`	`Executor`: Executor identifying the thread on which the callback should happen. If `null`, the callback will happen from the thread pool of the process.
`onFinished`	`IntentSender.OnFinished`: The object to call back on when the send has completed, or `null` for no callback.

Throws
`IntentSender.SendIntentException`	Throws CanceledIntentException if the IntentSender is no longer allowing more intents to be sent through it.

sendIntent

Added in API level 4

public 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

public 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

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeIntentSenderOrNullToParcel

Added in API level 4

public static 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

public 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. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

IntentSender

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

equals

getCreatorPackage

getCreatorUid

getCreatorUserHandle

getTargetPackage

hashCode

readIntentSenderOrNullFromParcel

sendIntent

sendIntent

sendIntent

toString

writeIntentSenderOrNullToParcel

writeToParcel