Skip to content

Most visited

Recently visited

navigation

BroadcastReceiver.PendingResult

public static class BroadcastReceiver.PendingResult
extends Object

java.lang.Object
   ↳ android.content.BroadcastReceiver.PendingResult


State for a result that is pending for a broadcast receiver. Returned by goAsync() while in BroadcastReceiver.onReceive(). This allows you to return from onReceive() without having the broadcast terminate; you must call finish() once you are done with the broadcast. This allows you to process the broadcast off of the main thread of your app.

Note on threading: the state inside of this class is not itself thread-safe, however you can use it from any thread if you properly sure that you do not have races. Typically this means you will hand the entire object to another thread, which will be solely responsible for setting any results and finally calling finish().

Summary

Public methods

final void abortBroadcast()

Version of BroadcastReceiver.abortBroadcast() for asynchronous broadcast handling.

final void clearAbortBroadcast()

Version of BroadcastReceiver.clearAbortBroadcast() for asynchronous broadcast handling.

final void finish()

Finish the broadcast.

final boolean getAbortBroadcast()

Version of BroadcastReceiver.getAbortBroadcast() for asynchronous broadcast handling.

final int getResultCode()

Version of BroadcastReceiver.getResultCode() for asynchronous broadcast handling.

final String getResultData()

Version of BroadcastReceiver.getResultData() for asynchronous broadcast handling.

final Bundle getResultExtras(boolean makeMap)

Version of BroadcastReceiver.getResultExtras(boolean) for asynchronous broadcast handling.

final void setResult(int code, String data, Bundle extras)

Version of BroadcastReceiver.setResult(int, String, Bundle) for asynchronous broadcast handling.

final void setResultCode(int code)

Version of BroadcastReceiver.setResultCode(int) for asynchronous broadcast handling.

final void setResultData(String data)

Version of BroadcastReceiver.setResultData(String) for asynchronous broadcast handling.

final void setResultExtras(Bundle extras)

Version of BroadcastReceiver.setResultExtras(Bundle) for asynchronous broadcast handling.

Inherited methods

From class java.lang.Object

Public methods

abortBroadcast

Added in API level 11
void abortBroadcast ()

Version of BroadcastReceiver.abortBroadcast() for asynchronous broadcast handling.

clearAbortBroadcast

Added in API level 11
void clearAbortBroadcast ()

Version of BroadcastReceiver.clearAbortBroadcast() for asynchronous broadcast handling.

finish

Added in API level 11
void finish ()

Finish the broadcast. The current result will be sent and the next broadcast will proceed.

getAbortBroadcast

Added in API level 11
boolean getAbortBroadcast ()

Version of BroadcastReceiver.getAbortBroadcast() for asynchronous broadcast handling.

Returns
boolean

getResultCode

Added in API level 11
int getResultCode ()

Version of BroadcastReceiver.getResultCode() for asynchronous broadcast handling.

Returns
int

getResultData

Added in API level 11
String getResultData ()

Version of BroadcastReceiver.getResultData() for asynchronous broadcast handling.

Returns
String

getResultExtras

Added in API level 11
Bundle getResultExtras (boolean makeMap)

Version of BroadcastReceiver.getResultExtras(boolean) for asynchronous broadcast handling.

Parameters
makeMap boolean
Returns
Bundle

setResult

Added in API level 11
void setResult (int code, 
                String data, 
                Bundle extras)

Version of BroadcastReceiver.setResult(int, String, Bundle) for asynchronous broadcast handling.

Parameters
code int
data String
extras Bundle

setResultCode

Added in API level 11
void setResultCode (int code)

Version of BroadcastReceiver.setResultCode(int) for asynchronous broadcast handling.

Parameters
code int

setResultData

Added in API level 11
void setResultData (String data)

Version of BroadcastReceiver.setResultData(String) for asynchronous broadcast handling.

Parameters
data String

setResultExtras

Added in API level 11
void setResultExtras (Bundle extras)

Version of BroadcastReceiver.setResultExtras(Bundle) for asynchronous broadcast handling.

Parameters
extras Bundle
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.