Added in API level 4

IntentSender

open class IntentSender : Parcelable
kotlin.Any
   ↳ 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 android.app.PendingIntent with PendingIntent.getIntentSender().

Summary

Nested classes
abstract

Callback interface for discovering when a send operation has completed.
open

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
Public methods
open Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Boolean
equals(other: Any?)

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

Return the package name of the application that created this IntentSender, that is the identity under which you will actually be sending the Intent.
open Int

Return the uid of the application that created this PendingIntent, that is the identity under which you will actually be sending the Intent.
open UserHandle!

Return the user handle of the application that created this PendingIntent, that is the user under which you will actually be sending the Intent.
open String!

open Int

Returns a hash code value for the object.
open static IntentSender!

Convenience function for reading either a Messenger or null pointer from a Parcel.
open Unit
sendIntent(context: Context!, code: Int, intent: Intent!, onFinished: IntentSender.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.
open Unit
sendIntent(context: Context!, code: Int, intent: Intent!, onFinished: IntentSender.OnFinished!, handler: Handler!, requiredPermission: String!)

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.
open Unit
sendIntent(context: Context?, code: Int, intent: Intent?, requiredPermission: String?, options: Bundle?, executor: Executor?, onFinished: IntentSender.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.
open String

Returns a string representation of the object.
open static Unit

Convenience function for writing either a IntentSender or null pointer to a Parcel.
open Unit
writeToParcel(out: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<IntentSender!>

Public methods

describeContents

Added in API level 4
open fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 4
open fun equals(other: Any?): Boolean

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

Parameters
obj the reference object with which to compare.
otherObj This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getCreatorPackage

Added in API level 17
open fun getCreatorPackage(): String!

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.

Return
String! The package name of the PendingIntent, or null if there is none associated with it.

getCreatorUid

Added in API level 17
open fun getCreatorUid(): Int

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.

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

getCreatorUserHandle

Added in API level 17
open fun getCreatorUserHandle(): UserHandle!

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.

Return
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
open fun getTargetPackage(): String!

Deprecated: Renamed to getCreatorPackage().

hashCode

Added in API level 4
open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

readIntentSenderOrNullFromParcel

Added in API level 4
open static fun readIntentSenderOrNullFromParcel(in: Parcel!): IntentSender!

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

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

sendIntent

Added in API level 4
open fun sendIntent(
    context: Context!, 
    code: Int, 
    intent: Intent!, 
    onFinished: IntentSender.OnFinished!, 
    handler: Handler!
): Unit

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.
Exceptions
android.content.IntentSender.SendIntentException Throws CanceledIntentException if the IntentSender is no longer allowing more intents to be sent through it.

sendIntent

Added in API level 14
open fun sendIntent(
    context: Context!, 
    code: Int, 
    intent: Intent!, 
    onFinished: IntentSender.OnFinished!, 
    handler: Handler!, 
    requiredPermission: String!
): Unit

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.
Exceptions
android.content.IntentSender.SendIntentException Throws CanceledIntentException if the IntentSender is no longer allowing more intents to be sent through it.

sendIntent

Added in API level 36
open fun sendIntent(
    context: Context?, 
    code: Int, 
    intent: Intent?, 
    requiredPermission: String?, 
    options: Bundle?, 
    executor: Executor?, 
    onFinished: IntentSender.OnFinished?
): Unit

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.
Exceptions
android.content.IntentSender.SendIntentException Throws CanceledIntentException if the IntentSender is no longer allowing more intents to be sent through it.

toString

Added in API level 4
open fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeIntentSenderOrNullToParcel

Added in API level 4
open static fun writeIntentSenderOrNullToParcel(
    sender: IntentSender!, 
    out: Parcel!
): Unit

Convenience function for writing either a IntentSender or null pointer to a Parcel. You must use this with readIntentSenderOrNullFromParcel 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
open fun writeToParcel(
    out: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest 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_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:

Properties

CREATOR

Added in API level 4
static val CREATOR: Parcelable.Creator<IntentSender!>