Android APIs
public class

ResultReceiver

extends Object
implements Parcelable
java.lang.Object
   ↳ android.os.ResultReceiver

Class Overview

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

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

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<ResultReceiver> CREATOR
Public Constructors
ResultReceiver(Handler handler)
Create a new ResultReceive to receive results.
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
void send(int resultCode, Bundle resultData)
Deliver a result to this receiver.
void writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel.
Protected Methods
void onReceiveResult(int resultCode, Bundle resultData)
Override to receive results delivered to this object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<ResultReceiver> CREATOR

Added in API level 3

Public Constructors

public ResultReceiver (Handler handler)

Added in API level 3

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

Parameters
handler Handler

Public Methods

public int describeContents ()

Added in API level 3

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

Returns
int a bitmask indicating the set of special object types marshalled by the Parcelable.

public void send (int resultCode, Bundle resultData)

Added in API level 3

Deliver a result to this receiver. Will call onReceiveResult(int, Bundle), 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.

public void writeToParcel (Parcel out, int flags)

Added in API level 3

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.

Protected Methods

protected void onReceiveResult (int resultCode, Bundle resultData)

Added in API level 3

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.