You are reading 12.7.1. See this page in 13.4.1.
Titanium.Android.BroadcastReceiver
Extends Titanium.Proxy
Monitor and handle Android system broadcasts.
The application can use broadcast receivers to monitor system events from the Android OS as well as custom broadcasts sent by other applications. The application will need to know the name of the broadcast actions in order to monitor them. Note that Titanium only supports programmatically creating and registering broadcast receivers. Titanium does not support declaring a receiver in the Android manifest.
To create a Broadcast Receiver, use the Titanium.Android.createBroadcastReceiver method.
Specify either a callback to handle the broadcast with the onReceived property or a
JavaScript file with the url property. Do not specify both. If both properties are
used, the url property takes precedence.
To start listening to a broadcast, pass the BroadcastReceiver object and an array of
broadcast actions to listen for to the Titanium.Android.registerBroadcastReceiver method.
Titanium exposes some of the system-level broadcasts as the Titanium.Android.ACTION_*
constants. Note that some of these constants are not broadcast messages.
You can also define a custom broadcast action. Use a reverse domain name scheme in order to avoid potential conflicts with other applications.
To stop listening to a broadcast, pass the BroadcastReceiver object to the
Titanium.Android.unregisterBroadcastReceiver method.
To monitor a broadcast that requires a special permission, declare the <uses-permission>
element in the Android manifest section of the tiapp.xml file for each broadcast that uses
a special permission. For example, to monitor the NEW_OUTGOING_CALL broadcast, the
application needs to add the following permission:
<ti:app>
<android>
<manifest>
<uses-permission android:name="android.permission.NEW_OUTGOING_CALL" />
</manifest>
</android>
</ti:app>Further Reading:
Examples
Create and register a broadcast receiver
This example creates a broadcast receiver and registers it to handle the airplane mode broadcast.
var bc = Ti.Android.createBroadcastReceiver({
onReceived: function() {
Ti.API.info('Handling broadcast.');
}
});
Ti.Android.registerBroadcastReceiver(bc, [Ti.Android.ACTION_AIRPLANE_MODE_CHANGED]);Properties 5
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Inherited from Titanium.Proxy
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
onReceived
Callback<Object>The function called when a broadcast is received.
url
StringURL of the JavaScript file to handle the broadcast.
Methods 4
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| event? | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|