# Titanium.Geolocation.Android.LocationRule

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

Availability
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

Availability
2.0.0
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.


# maxAge

Availability
2.0.0
maxAge :Number

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


# minAge

Availability
2.0.0
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

Availability
2.0.0
name :String

If specified, this rule only applies to updates generated by the specified provider. If null, this rule applies to all updates.

Default: null