Titanium.Geolocation.Android.LocationRule
> Titanium.Geolocation.Android.LocationRule

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.

  • 2.0.0
Defined By

Properties

Titanium.Geolocation.Android.LocationRule
accuracy : Number

Minimum accuracy required for a location update.

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 : Stringreadonly

The name of the API that this proxy corresponds to.

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, Button returns Ti.UI.Button.

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

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

  • 3.0.0
  • 3.0.0
  • 3.0.0

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

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.

  • 3.6.0
Titanium.Geolocation.Android.LocationRule
: Number
Controls the freshness of location updates. ...

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

Titanium.Geolocation.Android.LocationRule
minAge : Number

Controls the frequency of location updates.

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

Titanium.Geolocation.Android.LocationRule
: String
If specified, this rule only applies to updates generated by the specified provider. ...

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:

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Titanium.Geolocation.Android.LocationRule
( ) : Number
Gets the value of the accuracy property. ...

Gets the value of the accuracy property.

Returns

  • Number
Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.Geolocation.Android.LocationRule
( ) : Number
Gets the value of the maxAge property. ...

Gets the value of the maxAge property.

Returns

  • Number
Titanium.Geolocation.Android.LocationRule
( ) : Number
Gets the value of the minAge property. ...

Gets the value of the minAge property.

Returns

  • Number
Titanium.Geolocation.Android.LocationRule
( ) : String
Gets the value of the name property. ...

Gets the value of the name property.

Returns

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

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 : String

    Name of the event.

  • callback : Callback<Object>

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

Returns

  • void
Titanium.Geolocation.Android.LocationRule
( accuracy )
Sets the value of the accuracy property. ...

Sets the value of the accuracy property.

Parameters

  • accuracy : Number

    New value for the property.

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.Geolocation.Android.LocationRule
( maxAge )
Sets the value of the maxAge property. ...

Sets the value of the maxAge property.

Parameters

  • maxAge : Number

    New value for the property.

Returns

  • void
Titanium.Geolocation.Android.LocationRule
( minAge )
Sets the value of the minAge property. ...

Sets the value of the minAge property.

Parameters

  • minAge : Number

    New value for the property.

Returns

  • void
Titanium.Geolocation.Android.LocationRule
( name )
Sets the value of the name property. ...

Sets the value of the name property.

Parameters

  • name : String

    New value for the property.

Returns

  • void