<receiver android:directBootAware=["true" | "false"] android:enabled=["true" | "false"] android:exported=["true" | "false"] android:icon="drawable resource" android:label="string resource" android:name="string" android:permission="string" android:process="string" > . . . </receiver>
- contained in:
- can contain:
- Declares a broadcast receiver (a
BroadcastReceiversubclass) as one of the application's components. Broadcast receivers enable applications to receive intents that are broadcast by the system or by other applications, even when other components of the application are not running.
There are two ways to make a broadcast receiver known to the system: One is declare it in the manifest file with this element. The other is to create the receiver dynamically in code and register it with the
method. For more information about how to dynamically create receivers, see the
Warning: Limit how many broadcast receivers you set in your app. Having too many broadcast receivers can affect your app's performance and the battery life of users' devices. For more information about APIs you can use instead of the
BroadcastReceiverclass for scheduling background work, see Background Optimizations.
Whether or not the broadcast receiver is direct-boot aware; that is, whether or not it can run before the user unlocks the device.
Note: During Direct Boot, a broadcast receiver in your application can only access the data that is stored in device protected storage.
The default value is
- Whether or not the broadcast receiver can be instantiated by the system —
true" if it can be, and "
false" if not. The default value is "
<application>element has its own
enabledattribute that applies to all application components, including broadcast receivers. The
<receiver>attributes must both be "
true" for the broadcast receiver to be enabled. If either is "
false", it is disabled; it cannot be instantiated.
- Whether the broadcast receiver can receive messages from non-system sources
outside its application — "
true" if it can, and "
false" if not. If "
false", the only messages the broadcast receiver can receive are those sent by the system, components of the same application, or applications with the same user ID.
If unspecified, the default value depends on whether the broadcast receiver contains intent filters. If the receiver contains at least one intent filter, then the default value is "
true". Otherwise, the default value is "
This attribute is not the only way to limit a broadcast receiver's external exposure. You can also use a permission to limit the external entities that can send it messages (see the
- An icon representing the broadcast receiver. This attribute must be set
as a reference to a drawable resource containing the image definition.
If it is not set, the icon specified for the application as a whole is used
instead (see the
- A user-readable label for the broadcast receiver. If this attribute is not
set, the label set for the application as a whole is
used instead (see the
The broadcast receiver's label — whether set here or by the
<application>element — is also the default label for all the receiver's intent filters (see the
The label should be set as a reference to a string resource, so that it can be localized like other strings in the user interface. However, as a convenience while you're developing the application, it can also be set as a raw string.
- The name of the class that implements the broadcast receiver, a subclass of
BroadcastReceiver. This should be a fully qualified class name (such as, "
com.example.project.ReportReceiver"). However, as a shorthand, if the first character of the name is a period (for example, "
. ReportReceiver"), it is appended to the package name specified in the
There is no default. The name must be specified.
- The name of a permission that broadcasters must have to send a
message to the broadcast receiver.
If this attribute is not set, the permission set by the
permissionattribute applies to the broadcast receiver. If neither attribute is set, the receiver is not protected by a permission.
- The name of the process in which the broadcast receiver should run.
Normally, all components of an application run in the default process created
for the application. It has the same name as the application package. The
processattribute can set a different default for all components. But each component can override the default with its own
processattribute, allowing you to spread your application across multiple processes.
If the name assigned to this attribute begins with a colon (':'), a new process, private to the application, is created when it's needed and the broadcast receiver runs in that process. If the process name begins with a lowercase character, the receiver will run in a global process of that name, provided that it has permission to do so. This allows components in different applications to share a process, reducing resource usage.
- introduced in:
- API Level 1
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2021-01-19 UTC.