Titanium SDK

# Titanium.Android.BroadcastReceiver

Monitor and handle Android system broadcasts.

Availability
3.1.0
Extends
Titanium.Proxy

# Overview

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

# apiName READONLY

Availability
3.2.0
apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
3.1.0
bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# lifecycleContainer

Availability
3.6.0
lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# onReceived

Availability
3.1.0
onReceived :Callback<Object>

The function called when a broadcast is received.

# url

Availability
3.1.0
url :String

URL of the JavaScript file to handle the broadcast.

# Methods

# addEventListener

Availability
3.1.0
addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
3.1.0
applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
3.1.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name 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.

Returns

Type
void

# removeEventListener

Availability
3.1.0
removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

Contents