public class
LocalBroadcastManager
extends Object
| java.lang.Object | |
| ↳ | android.support.v4.content.LocalBroadcastManager |
Class Overview
Helper to register for and send broadcasts of Intents to local objects within your process. This is has a number of advantages over sending global broadcasts withsendBroadcast(Intent):
- You know that the data you are broadcasting won't leave your app, so don't need to worry about leaking private data.
- It is not possible for other applications to send these broadcasts to your app, so you don't need to worry about having security holes they can exploit.
- It is more efficient than sending a global broadcast through the system.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static LocalBroadcastManager | getInstance(Context context) | ||||||||||
| void |
registerReceiver(BroadcastReceiver receiver, IntentFilter filter)
Register a receive for any local broadcasts that match the given IntentFilter.
|
||||||||||
| boolean |
sendBroadcast(Intent intent)
Broadcast the given intent to all interested BroadcastReceivers.
|
||||||||||
| void |
sendBroadcastSync(Intent intent)
Like
sendBroadcast(Intent), but if there are any receivers for the Intent this function will block and immediately dispatch them before returning. |
||||||||||
| void |
unregisterReceiver(BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver.
|
||||||||||
|
[Expand]
Inherited Methods
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|||||||||||
Public Methods
public void registerReceiver (BroadcastReceiver receiver, IntentFilter filter)
Register a receive for any local broadcasts that match the given IntentFilter.
Parameters
| receiver | The BroadcastReceiver to handle the broadcast. |
|---|---|
| filter | Selects the Intent broadcasts to be received. |
public boolean sendBroadcast (Intent intent)
Broadcast the given intent to all interested BroadcastReceivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
Parameters
| intent | The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
|---|
public void sendBroadcastSync (Intent intent)
Like sendBroadcast(Intent), but if there are any receivers for the Intent this function will block and immediately dispatch them before returning.
public void unregisterReceiver (BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.
Parameters
| receiver | The BroadcastReceiver to unregister. |
|---|