ResultReceiver

Kotlin |Java

open class ResultReceiver : Parcelable

kotlin.Any
↳	android.os.ResultReceiver

Generic interface for receiving a callback result from someone. Use this by creating a subclass and implement onReceiveResult, which you can then pass to others and send through IPC, and receive results they supply with send.

Note: the implementation underneath is just a simple wrapper around a Binder that is used to perform the communication. This means semantically you should treat it as such: this class does not impact process lifecycle management (you must be using some higher-level component to tell the system that your process needs to continue running), the connection will break if your process goes away for any reason, etc.

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`ResultReceiver(handler: Handler!)` Create a new ResultReceive to receive results.

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Unit	`send(resultCode: Int, resultData: Bundle!)` Deliver a result to this receiver.
open Unit	`writeToParcel(out: Parcel, flags: Int)` Flatten this object in to a Parcel.

Protected methods
open Unit	`onReceiveResult(resultCode: Int, resultData: Bundle!)` Override to receive results delivered to this object.

Properties
static Parcelable.Creator<ResultReceiver!>	`CREATOR`

Public constructors

ResultReceiver

Added in API level 3

ResultReceiver(handler: Handler!)

Create a new ResultReceive to receive results. Your onReceiveResult method will be called from the thread running handler if given, or from an arbitrary thread if null.

Public methods

describeContents

Added in API level 3

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

send

Added in API level 3

open fun send(
    resultCode: Int, 
    resultData: Bundle!
): Unit

Deliver a result to this receiver. Will call onReceiveResult, always asynchronously if the receiver has supplied a Handler in which to dispatch the result.

Parameters
`resultCode`	Int: Arbitrary result code to deliver, as defined by you.
`resultData`	Bundle!: Any additional data provided by you.

writeToParcel

Added in API level 3

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: `PARCELABLE_WRITE_RETURN_VALUE`

Protected methods

onReceiveResult

Added in API level 3

protected open fun onReceiveResult(
    resultCode: Int, 
    resultData: Bundle!
): Unit

Override to receive results delivered to this object.

Parameters
`resultCode`	Int: Arbitrary result code delivered by the sender, as defined by the sender.
`resultData`	Bundle!: Any additional data provided by the sender.

Properties

CREATOR

Added in API level 3

static val CREATOR: Parcelable.Creator<ResultReceiver!>