Titanium SDK # Titanium.Geolocation.Android.LocationRule
A location rule to filter the results returned by location providers.
2.0.0# Overview
All of the properties are optional.
See Titanium.Geolocation.Android for details on using LocationProviders to
manually configure location updates.
# Properties
# accuracy
2.0.0Minimum accuracy required for a location update.
Accuracy is expressed as the maximum allowable error, in meters. To pass this rule, an update must have an accuracy value equal to or lower than this value.
# apiName READONLY
3.2.0The 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
3.0.0Indicates 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
3.6.0The 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.
# maxAge
2.0.0Controls the freshness of location updates. Do not forward an update
unless it is newer than maxAge milliseconds.
# minAge
2.0.0Controls the frequency of location updates.
Do not forward an update unless at least minAge milliseconds have passed since the last
good location update (that is, the last update from any provider that generated a
location event).
# name
2.0.0If specified, this rule only applies to updates generated
by the specified provider. If null, this rule applies to all updates.
Can be PROVIDER_GPS, PROVIDER_NETWORK, or PROVIDER_PASSIVE.
Default: null
# Methods
# addEventListener
2.0.0Adds 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
3.0.0Applies 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
2.0.0Fires 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
2.0.0Removes 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 |
Returns
- Type
- void