English | Site Directory

Android - An Open Handset Alliance Project

android.content
public abstract class

android.content.IntentReceiver

java.lang.Object
android.content.IntentReceiver

Base class for code that will receive intents sent by broadcastIntent(). You can either dynamically register an instance of this class with Context.registerReceiver() or statically publish an implementation through the <receiver> tag in your AndroidManifest.xml. Note:    If registering a receiver in your Activity.onResume() implementation, you should unregister it in Activity.onPause(). (You won't receive intents when paused, and this will cut down on unnecessary system overhead). Do not unregister in Activity.onFreeze(), because this won't be called if the user moves back in the history stack.

Note that, although the Intent class is used for sending and receiving these broadcasts, the Intent broadcast mechanism here is completely separate from Intents that are used to start Activities with Context.startActivity(). There is no way for an IntentReceiver to see or capture Intents used with startActivity(); likewise, when you broadcast an Intent, you will never find or start an Activity. These two operations are semantically very different: starting an Activity with an Intent is a foreground operation that modifies what the user is currently interacting with; broadcasting an Intent is a background operation that the user is not normally aware of.

The IntentReceiver class (when launched as a component through a manifest's <receiver> tag) is an important part of an application's overall lifecycle.

Topics covered here:

  1. Receiver Lifecycle
  2. Permissions
  3. Process Lifecycle

Receiver Lifecycle

An IntentReceiver object is only valid for the duration of the call to onReceiveIntent(Context, Intent). Once your code returns from this function, the system considers the object to be finished and no longer active.

This has important repercussions to what you can do in an onReceiveIntent(Context, Intent) implementation: anything that requires asynchronous operation is not available, because you will need to return from the function to handle the asynchronous operation, but at that point the IntentReceiver is no longer active and thus the system is free to kill its process before the asynchronous operation completes.

In particular, you may not show a dialog or bind to a service from within an IntentReceiver. For the former, you should instead use the NotificationManager API. For the latter, you can use Context.startService() to send a command to the service.

Permissions

Access permissions can be enforced by either the sender or receiver of an Intent.

To enforce a permission when sending, you supply a non-null permission argument to broadcastIntent(Intent, String) or broadcastIntent(Intent, String, IntentReceiver, android.os.Handler, int, String, Bundle). Only receivers who have been granted this permission (by requesting it with the <uses-permission> tag in their AndroidManifest.xml) will be able to receive the broadcast.

To enforce a permission when receiving, you supply a non-null permission when registering your receiver -- either when calling registerReceiver(IntentReceiver, IntentFilter, String, android.os.Handler) or in the static <receiver> tag in your AndroidManifest.xml. Only broadcasters who have been granted this permission (by requesting it with the <uses-permission> tag in their AndroidManifest.xml) will be able to send an Intent to the receiver.

See the Security Model document for more information on permissions and security in general.

Process Lifecycle

A process that is currently executing an IntentReceiver (that is, currently running the code in its onReceiveIntent(Context, Intent) method) is considered to be a foreground process and will be kept running by the system except under cases of extreme memory pressure.

Once you return from onReceiveIntent(), the IntentReceiver is no longer active, and its hosting process is only as important as any other application components that are running in it. This is especially important because if that process was only hosting the IntentReceiver (a common case for applications that the user has never or not recently interacted with), then upon returning from onReceiveIntent() the system will consider its process to be empty and aggressively kill it so that resources are available for other more important processes.

This means that for longer-running operations you will often use a Service in conjunction with an IntentReceiver to keep the containing process active for the entire time of your operation.

Known Direct Subclasses

Summary

Public Constructors

          IntentReceiver()

Public Methods

    final    void  abortBroadcast()
Sets the flag indicating that this receiver should abort the current broadcast.
    final    void  clearAbortBroadcast()
Clears the flag indicating that this receiver should abort the current broadcast.
    final    boolean  getAbortBroadcast()
Returns the flag indicating whether or not this receiver should abort the current broadcast.
    final    boolean  getDebugUnregister()
Return the last value given to setDebugUnregister(boolean).
    final    int  getResultCode()
Retrieve the current result code, as set by the previous receiver.
    final    String  getResultData()
Retrieve the current result data, as set by the previous receiver.
    final    Bundle  getResultExtras(boolean makeMap)
Retrieve the current result extra data, as set by the previous receiver.
abstract        void  onReceiveIntent(Context context, Intent intent)
This method is called when the IntentReceiver is receiving an Intent broadcast.
    final    void  setDebugUnregister(boolean debug)
Control inclusion of debugging help for mismatched calls to {@ Context#registerReceiver(IntentReceiver, IntentFilter) Context.registerReceiver()}.
    final    void  setResult(int code, String data, Bundle extras)
    final    void  setResultCode(int code)
Change the current result code of this broadcast.
    final    void  setResultData(String data)
Change the current result data of this broadcast.
    final    void  setResultExtras(Bundle extras)
Change the current result extras of this broadcast.
Methods inherited from class java.lang.Object

Details

Public Constructors

public IntentReceiver()

Public Methods

public final void abortBroadcast()

Sets the flag indicating that this receiver should abort the current broadcast. This will prevent any other intent receivers from receiving the broadcast. It will still call onReceiveIntent(Context, Intent) of the IntentReceiver that the caller of broadcastIntent(Intent) passed in.

public final void clearAbortBroadcast()

Clears the flag indicating that this receiver should abort the current broadcast.

public final boolean getAbortBroadcast()

Returns the flag indicating whether or not this receiver should abort the current broadcast.

Returns

  • True if the broadcast should be aborted.

public final boolean getDebugUnregister()

Return the last value given to setDebugUnregister(boolean).

public final int getResultCode()

Retrieve the current result code, as set by the previous receiver.

Returns

  • int The current result code.

public final String getResultData()

Retrieve the current result data, as set by the previous receiver. Often this is null.

Returns

  • String The current result data; may be null.

public final Bundle getResultExtras(boolean makeMap)

Retrieve the current result extra data, as set by the previous receiver. Any changes you make to the returned Map will be propagated to the next receiver.

Parameters

makeMap If true then a new empty Map will be made for you if the current Map is null; if false you should be prepared to receive a null Map.

Returns

  • Map The current extras map.

public abstract void onReceiveIntent(Context context, Intent intent)

This method is called when the IntentReceiver is receiving an Intent broadcast. During this time you can use the other methods on IntentReceiver to view/modify the current result values. The function is normally called from the main thread of its process, so you should never perform long-running operations in it (there is a timeout of 10 seconds that the system allows before considering the receiver to be blocked and a candidate to be killed). You cannot launch a popup dialog in your implementation of onReceiveIntent().

If this IntentReceiver was launched through a <receiver> tag, then the object is no longer alive after returning from this function. This means you should not perform any operations that return a result to you asynchronously -- in particular, for interacting with services, you should use startService(Intent, Bundle) instead of bindService(Intent, ServiceConnection, int).

Parameters

context The Context in which the receiver is running.
intent The Intent being received.

public final void setDebugUnregister(boolean debug)

Control inclusion of debugging help for mismatched calls to {@ Context#registerReceiver(IntentReceiver, IntentFilter) Context.registerReceiver()}. If called with true, before given to registerReceiver(), then the callstack of the following Context.unregisterReceiver() call is retained, to be printed if a later incorrect unregister call is made. Note that doing this requires retaining information about the IntentReceiver for the lifetime of the app, resulting in a leak -- this should only be used for debugging.

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

public final void setResultCode(int code)

Change the current result code of this broadcast. Often uses the Activity RESULT_CANCELED and RESULT_OK constants, though the actual meaning of this value is ultimately up to the broadcaster.

Parameters

code The new result code.

public final void setResultData(String data)

Change the current result data of this broadcast. This is an arbitrary string whose interpretation is up to the broadcaster.

Parameters

data The new result data; may be null.

public final void setResultExtras(Bundle extras)

Change the current result extras of this broadcast. This is a Bundle holding arbitrary data, whose interpretation is up to the broadcaster. Can be set to null. Calling this method completely replaces the current map (if any).

Parameters

extras The new extra data map; may be null.
Build m5-rc15i - 10 Jun 2008 13:54