Titanium SDK

# Modules.Geofence.Region

Represents a geographic region to be monitored.

Availability
3.1.3
3.1.3
Extends
Titanium.Proxy

# Overview

A Region is a circular area defined by a center point (latitude, longitude) and a radius in meters. Use the Modules.Geofence.createRegion method to create a region.

# Properties

# apiName READONLY

Availability
3.2.0
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.3
3.1.3
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

# center

Availability
3.1.3
3.1.3
center :Dictionary

An object representing the center coordinate for the region.

The object must contain the following properties:

  • latitude: The latitude of the point to be tested
  • longitude: The longitude of the point to be tested

# identifier

Availability
3.1.3
3.1.3
identifier :String

The unique identifier of the region.

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

# notifyOnEntry

Availability
3.1.3
3.1.3
notifyOnEntry :Boolean

A boolean that controls whether the region will notify on entry.

If true, an enterregions event is generated when the device enters the region. If false, no event is generated. Default is true.

This property can only be set when calling createRegion.

# notifyOnExit

Availability
3.1.3
3.1.3
notifyOnExit :Boolean

A boolean that controlls whether the region will notify on exit.

If true, an exitregions event is generated when the device exit the region. If false, no event is generated. Default is true.

This property can only be set when calling createRegion.

# radius

Availability
3.1.3
3.1.3
radius :Number

The radius of the region to monitor in meters.

# Methods

# addEventListener

Availability
3.1.3
3.1.3
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.3
3.1.3
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

# containsCoordinate

Availability
3.1.3
containsCoordinate(point) → void

Returns true if the coordinates passed to the method represent a point that is within the region.

On iOS, if the device is located in a Modules.Geofence.Region that has just started being monitored, an enterregions event is not generated. Instead, when starting to monitor a new region, use this method to check if the device is located within a the current Region.

For example, the following code creates a new Region and then immediately checks if the device is located in the newly created region and, if so, displays a notification.

var region = Geofence.createRegion({
    center: { 
        latitude:37.389601,
        longitude:-122.050169
    },
    radius: 50,
    identifier: 'Appcelerator'
});

// Should be true
if (region.containsCoordinate(e.coords)) {
    var notification = Ti.App.iOS.scheduleLocalNotification({
        alertBody: 'Point is within region: ' + region.identifier
    });
}

Parameters

Name Type Description
point Dictionary

A Dictionary that defines latitude and longitude properties.

Returns

Type
void

# fireEvent

Availability
3.1.3
3.1.3
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.3
3.1.3
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