- Tutorials
- Eclipse IDE
- Eclipse RCP
- Eclipse IDE Extensions
- Android Programming
- Web
- Java
- Technology
- Software design
- Code @ GitHub
- Training
- Eclipse RCP Training
- Cross Mobile App Dev. Training
- Git and Gerrit Training
- Self-study Portal
- Other Onsite Training
- Consulting
- Company
- Jobs
- People
- Customers
- Blog
- Books
- Eclipse RCP
- Eclipse IDE
- Contributing to the Eclipse Project
- Git
- Research Projects
- Donate
- Contact us
Get more...
- Read Premium Content ...
- Book Onsite or Virtual Training
- Consulting
Training Events
- Now offering virtual, onsite and online training
Android BroadcastReceiver - Tutorial
Version 3.1,27.06.2016
- 1. Broadcast receiver
- 1.1. Definition
- 1.2. Implementation
- 1.3. Life cycle of a broadcast receiver
- 1.4. Asynchronous processing
- 1.5. Restrictions for defining broadcast receiver
- 1.6. Send the broadcast to your application for testing
- 1.7. Pending Intent
- 2. System broadcasts
- 3. Automatically starting Services from a Receivers
- 4. Exercise: Register a receiver for incoming phone calls
- 4.1. Target
- 4.2. Create project
- 4.3. Implement receiver for the phone event
- 4.4. Request permission
- 4.5. Validate implementations
- 5. Exercise: System services and receiver
- 5.1. Target
- 5.2. Implement project
- 5.3. Validate implementation
- 6. Dynamic broadcast receiver registration
- 6.1. Dynamically registered receiver
- 6.2. Using the package manager to disable static receivers
- 6.3. Sticky [broadcast] intents
- 7. Links and Literature
- 7.1. Android Resources
- 8. vogella training and consulting support
- Appendix A: Copyright, License and Source code
Using Broadcast receivers in Android. This tutorial describes how to create and consume broadcast receivers in Android.
1. Broadcast receiver
1.1. Definition
A broadcast receiver [receiver] is an Android component which allows you to register for system or application events. All registered receivers for an event are notified by the Android runtime once this event happens.
For example, applications can register for the ACTION_BOOT_COMPLETED system event which is fired once the Android system has completed the boot process.
1.2. Implementation
A receiver can be registered via the AndroidManifest.xml file.
Alternatively to this static registration, you can also register a receiver dynamically via the Context.registerReceiver[] method.
The implementing class for a receiver extends the BroadcastReceiver class.
If the event for which the broadcast receiver has registered happens, the onReceive[] method of the receiver is called by the Android system.
1.3. Life cycle of a broadcast receiver
After the onReceive[] of the receiver class has finished, the Android system is allowed to recycle the receiver.
1.4. Asynchronous processing
Before API level 11, you could not perform any asynchronous operation in the onReceive[] method, because once the onReceive[] method had been finished, the Android system was allowed to recycle that component. If you have potentially long running operations, you should trigger a service instead.
Since Android API 11 you can call the goAsync[] method. This method returns an object of the PendingResult type. The Android system considers the receiver as alive until you call the PendingResult.finish[] on this object. With this option you can trigger asynchronous processing in a receiver. As soon as that thread has completed, its task calls finish[] to indicate to the Android system that this component can be recycled.
1.5. Restrictions for defining broadcast receiver
As of Android 3.1 the Android system excludes all receiver from receiving intents by default if the corresponding application has never been started by the user or if the user explicitly stopped the application via the Android menu [in Manage Application ].
This is an additional security feature as the user can be sure that only the applications he started will receive broadcast intents.
1.6. Send the broadcast to your application for testing
You can use the following command from the adb command line tool. The class name and package names which are targeted via the command line tool need to be as defined in the manifest. You should send the intent you generated to your specific component, for example if you send a general ACTION_BOOT_COMPLETED broadcast, this will trigger a lot of things in an Android system.
1.7. Pending Intent
A pending intent is a token that you give to another application. For example, the notification manager, alarm manager or other 3rd party applications]. This allows the other application to restore the permissions of your application to execute a predefined piece of code.
To perform a broadcast via a pending intent, get a PendingIntent via the getBroadcast[] method of the PendingIntent class. To perform an activity via a pending intent, you receive the activity via PendingIntent.getActivity[].
2. System broadcasts
Several system events are defined as final static fields in the Intent class. Other Android system classes also define events, e.g., the TelephonyManager defines events for the change of the phone state.
The following table lists a few important system events.
Intent.ACTION_BOOT_COMPLETED
Boot completed. Requires the android.permission.RECEIVE_BOOT_COMPLETED permission
Intent.ACTION_POWER_CONNECTED
Power got connected to the device.
Intent.ACTION_POWER_DISCONNECTED
Power got disconnected to the device.
Intent.ACTION_BATTERY_LOW
Triggered on low battery. Typically used to reduce activities in your app which consume power.
Intent.ACTION_BATTERY_OKAY
Battery status good again.
3. Automatically starting Services from a Receivers
A common requirement is to automatically start a service after a system reboot, i.e., for synchronizing data. For this you can register a receiver for the android.intent.action.BOOT_COMPLETED system event. This requires the android.permission.RECEIVE_BOOT_COMPLETED permission.
The following example demonstrates the registration for the BOOT_COMPLETED event in the Android manifest file.
The receive would start the service as demonstrated in the following example code.
4. Exercise: Register a receiver for incoming phone calls
4.1. Target
In this exercise you define a broadcast receiver which listens to telephone state changes. If the phone receives a phone call, then our receiver will be notified and log a message.
4.2. Create project
Create a new project called de.vogella.android.receiver.phone. Also create an activity.
TIP:Remember that your receiver is only called if the user started it once. This requires an activity.
4.3. Implement receiver for the phone event
Create the MyPhoneReceiver class.
4.4. Request permission
Add the android.permission.READ_PHONE_STATE permission to your manifest file which allows you to listen to state changes in your receiver. Also Register your receiver in your manifest file. The resulting manifest should be similar to the following listing.
4.5. Validate implementations
Install your application and simulate a phone call via the emulator controls. Validate that your receiver is called and logs a message to the LogCat view.
5. Exercise: System services and receiver
5.1. Target
In this chapter we will schedule a receiver via the Android alert manager system service. Once called, it uses the Android vibrator manager and a popup message [Toast] to notify the user.
5.2. Implement project
Create a new project called de.vogella.android.alarm with the activity called AlarmActivity.
Create the following layout.
Create the following broadcast receiver class. This class will get the vibrator service.
Register this class as a broadcast receiver in AndroidManifest.xml and request authorization to vibrate the phone.
Change the code of your AlarmActivity class to the following. This activity creates an intent to start the receiver and register this intent with the alarm manager service.
5.3. Validate implementation
Run your application on the device. Set your time and start the alarm. After the defined number of seconds a Toast should be displayed. Keep in mind that the vibration alarm does not work on the Android emulator.
6. Dynamic broadcast receiver registration
6.1. Dynamically registered receiver
Receiver can be registered via the Android manifest file. You can also register and unregister a receiver at runtime via the Context.registerReceiver[] and Context.unregisterReceiver[] methods.
6.2. Using the package manager to disable static receivers
You can use the PackageManager class to enable or disable receivers registered in your AndroidManifest.xml file.
6.3. Sticky [broadcast] intents
An intent to trigger a receiver [ broadcast intent ] is not available anymore after it was sent and processed by the system. If you use the sendStickyBroadcast[Intent] method, the corresponding intent is sticky, meaning the intent you are sending stays around after the broadcast is complete.
The Android system uses sticky broadcast for certain system information. For example, the battery status is send as sticky intent and can get received at any time. The following example demonstrates that.
You can retrieve that data through the return value of registerReceiver[BroadcastReceiver, IntentFilter] `. This also works for a null `BroadcastReceiver.
In all other ways, this behaves just as sendBroadcast[Intent].
Sticky broadcast intents typically require special permissions.
7. Links and Literature
7.1. Android Resources
Android Development Tutorial
Android ListView and ListActivity
Android Location API and Google Maps
Android Intents
Android and Networking
Android Background processing with Threads and Asynchronous Task
Remote Messenger Service from Google
8. vogella training and consulting support
Online Training
Onsite Training
Consulting
Appendix A: Copyright, License and Source code
Copyright © 2012-2019 vogella GmbH. Free use of the software examples is granted under the terms of the Eclipse Public License 2.0. This tutorial is published under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Germany license.
Licence
Source code
Sponsor our Open Source development activities and our free content to help us make development easier for everyone