# Titanium.Geolocation.Android.LocationRule

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

- Source: https://titaniumsdk.com/docs/sdk/13.1.1/Titanium.Geolocation.Android.LocationRule
- Titanium SDK version: 13.1.1
- Kind: proxy
- Platforms: Android
- Since: Titanium SDK 2.0.0
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy

All of the properties are optional.

See [Titanium.Geolocation.Android](https://titaniumsdk.com/docs/sdk/Titanium.Geolocation.Android.md) for details on using `LocationProviders` to 
manually configure location updates.

## Properties

### accuracy

- Type: Number
- Platforms: Android

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

- Type: Number
- Platforms: Android

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

### minAge

- Type: Number
- Platforms: Android

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

- Type: String
- Platforms: Android
- Default: `null`

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](https://titaniumsdk.com/docs/sdk/Titanium.Geolocation.Android.md#PROVIDER_GPS), 
[PROVIDER_NETWORK](https://titaniumsdk.com/docs/sdk/Titanium.Geolocation.Android.md#PROVIDER_NETWORK), or 
[PROVIDER_PASSIVE](https://titaniumsdk.com/docs/sdk/Titanium.Geolocation.Android.md#PROVIDER_PASSIVE).

## Inherited members

7 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/13.1.1/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `lifecycleContainer`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.

