Browse the API284 types

Version13.3.0

You are reading 13.3.0. See this page in 13.4.1.

Titanium.Geolocation.Android.LocationRule

proxyAndroidsince 2.0.0

Extends Titanium.Proxy

A location rule to filter the results returned by location providers.

All of the properties are optional.

See Titanium.Geolocation.Android for details on using LocationProviders to manually configure location updates.

Properties 7

accuracy

Number

Minimum 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

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

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

Default: true

lifecycleContainer

Titanium.UI.Window | Titanium.UI.TabGroupsince 3.6.0

Inherited from Titanium.Proxy

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

maxAge

Number

Controls the freshness of location updates. Do not forward an update unless it is newer than maxAge milliseconds.

minAge

Number

Controls 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

String

If 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 4

addEventListener

Inherited from Titanium.Proxy

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

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

applyProperties

since 3.0.0

Inherited from Titanium.Proxy

Applies the properties to the proxy.

Parameters
Parameters	Type	Description
props	Dictionary	A dictionary of properties to apply.

fireEvent

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

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

removeEventListener

Inherited from Titanium.Proxy

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

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

Version13.3.0