Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/location/LocationRequest#nestedclasses) \| [Constants](https://developer.android.com/reference/android/location/LocationRequest#constants) \| [Inherited Constants](https://developer.android.com/reference/android/location/LocationRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/location/LocationRequest#lfields) \| [Methods](https://developer.android.com/reference/android/location/LocationRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/location/LocationRequest#inhmethods)

# LocationRequest

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/location/LocationRequest "View this page in Kotlin") \|Java


`
public

final

class
LocationRequest
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.location.LocationRequest |

<br />

*** ** * ** ***

An encapsulation of various parameters for requesting location via `https://developer.android.com/reference/android/location/LocationManager`.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/location/LocationRequest.Builder` A builder class for `https://developer.android.com/reference/android/location/LocationRequest`. |

| ### Constants ||
|---|---|
| `long` | `https://developer.android.com/reference/android/location/LocationRequest#PASSIVE_INTERVAL` Represents a passive only request. |
| `int` | `https://developer.android.com/reference/android/location/LocationRequest#QUALITY_BALANCED_POWER_ACCURACY` A quality constant indicating a location provider may choose to satisfy this request by equally balancing power and accuracy constraints. |
| `int` | `https://developer.android.com/reference/android/location/LocationRequest#QUALITY_HIGH_ACCURACY` A quality constant indicating a location provider may choose to satisfy this request by providing very accurate locations at the expense of potentially increased power usage. |
| `int` | `https://developer.android.com/reference/android/location/LocationRequest#QUALITY_LOW_POWER` A quality constant indicating a location provider may choose to satisfy this request by providing less accurate locations in order to save power. |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/location/LocationRequest>` | `https://developer.android.com/reference/android/location/LocationRequest#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/location/LocationRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/location/LocationRequest#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` long` | ` https://developer.android.com/reference/android/location/LocationRequest#getDurationMillis()() ` Returns the duration for which location will be provided before the request is automatically removed. |
| ` long` | ` https://developer.android.com/reference/android/location/LocationRequest#getIntervalMillis()() ` Returns the desired interval of location updates, or `https://developer.android.com/reference/android/location/LocationRequest#PASSIVE_INTERVAL` if this is a passive, no power request. |
| ` long` | ` https://developer.android.com/reference/android/location/LocationRequest#getMaxUpdateDelayMillis()() ` Returns the maximum time any location update may be delayed, and thus grouped with following updates to enable location batching. |
| ` int` | ` https://developer.android.com/reference/android/location/LocationRequest#getMaxUpdates()() ` Returns the maximum number of location updates for this request before the request is automatically removed. |
| ` float` | ` https://developer.android.com/reference/android/location/LocationRequest#getMinUpdateDistanceMeters()() ` Returns the minimum distance between location updates. |
| ` long` | ` https://developer.android.com/reference/android/location/LocationRequest#getMinUpdateIntervalMillis()() ` Returns the minimum update interval. |
| ` int` | ` https://developer.android.com/reference/android/location/LocationRequest#getQuality()() ` Returns the quality hint for this location request. |
| ` int` | ` https://developer.android.com/reference/android/location/LocationRequest#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/location/LocationRequest#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/location/LocationRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel parcel, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### PASSIVE_INTERVAL

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final long PASSIVE_INTERVAL
```

Represents a passive only request. Such a request will not trigger any active locations or
power usage itself, but may receive locations generated in response to other requests.

<br />

**See also:**

- `https://developer.android.com/reference/android/location/LocationRequest#getIntervalMillis()`

Constant Value:

9223372036854775807
(0x7fffffffffffffff)


### QUALITY_BALANCED_POWER_ACCURACY

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int QUALITY_BALANCED_POWER_ACCURACY
```

A quality constant indicating a location provider may choose to satisfy this request by
equally balancing power and accuracy constraints. Each location provider may interpret this
field differently, but location providers will generally use their default behavior when this
flag is present.

<br />

Constant Value:

102
(0x00000066)


### QUALITY_HIGH_ACCURACY

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int QUALITY_HIGH_ACCURACY
```

A quality constant indicating a location provider may choose to satisfy this request by
providing very accurate locations at the expense of potentially increased power usage. Each
location provider may interpret this field differently, but as an example, the network
provider may choose to return only wifi based locations rather than cell based locations in
order to have greater accuracy when this flag is present.

<br />

Constant Value:

100
(0x00000064)


### QUALITY_LOW_POWER

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int QUALITY_LOW_POWER
```

A quality constant indicating a location provider may choose to satisfy this request by
providing less accurate locations in order to save power. Each location provider may
interpret this field differently, but as an example, the network provider may choose to
return cell based locations rather than wifi based locations in order to save power when this
flag is present.

<br />

Constant Value:

104
(0x00000068)


## Fields

### CREATOR

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<LocationRequest> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object o)
```

Indicates whether some other object is "equal to" this one.


The `equals` method implements an equivalence relation
on non-null object references:

- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.


An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getDurationMillis

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long getDurationMillis ()
```

Returns the duration for which location will be provided before the request is automatically
removed. A duration of `Long.MAX_VALUE` represents an unlimited duration.

<br />

| Returns ||
|---|---|
| `long` | the duration for which location will be provided. Value is 1 or greater <br /> |

### getIntervalMillis

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long getIntervalMillis ()
```

Returns the desired interval of location updates, or `https://developer.android.com/reference/android/location/LocationRequest#PASSIVE_INTERVAL` if this is a
passive, no power request. A passive request will not actively generate location updates
(and thus will not be power blamed for location), but may receive location updates generated
as a result of other location requests. A passive request must always have an explicit
minimum update interval set.

Locations may be available at a faster interval than specified here, see
`https://developer.android.com/reference/android/location/LocationRequest#getMinUpdateIntervalMillis()` for the behavior in that case.

<br />

| Returns ||
|---|---|
| `long` | the desired interval of location updates. Value is 0 or greater <br /> |

### getMaxUpdateDelayMillis

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long getMaxUpdateDelayMillis ()
```

Returns the maximum time any location update may be delayed, and thus grouped with following
updates to enable location batching. If the maximum update delay is equal to or greater than
twice the interval, then location providers may provide batched results. The maximum batch
size is the maximum update delay divided by the interval. Not all devices or location
providers support batching, and use of this parameter does not guarantee that the client will
see batched results, or that batched results will always be of the maximum size.

When available, batching can provide substantial power savings to the device, and clients are
encouraged to take advantage where appropriate for the use case.

<br />

| Returns ||
|---|---|
| `long` | the maximum time by which a location update may be delayed. Value is 0 or greater <br /> |

**See also:**

- `https://developer.android.com/reference/android/location/LocationListener#onLocationChanged(java.util.List<android.location.Location>)`

### getMaxUpdates

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getMaxUpdates ()
```

Returns the maximum number of location updates for this request before the request is
automatically removed. A max updates value of `Integer.MAX_VALUE` represents an
unlimited number of updates.

<br />

| Returns ||
|---|---|
| `int` | Value is between 1 and `https://developer.android.com/reference/java/lang/Integer#MAX_VALUE` inclusive <br /> |

### getMinUpdateDistanceMeters

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getMinUpdateDistanceMeters ()
```

Returns the minimum distance between location updates. If a potential location update is
closer to the last location update than the minimum update distance, then the potential
location update will not occur. A value of 0 meters implies that no location update will ever
be rejected due to failing this constraint.

<br />

| Returns ||
|---|---|
| `float` | the minimum distance between location updates. Value is between 0.0f and `https://developer.android.com/reference/java/lang/Float#MAX_VALUE` inclusive <br /> |

### getMinUpdateIntervalMillis

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long getMinUpdateIntervalMillis ()
```

Returns the minimum update interval. If location updates are available faster than the
request interval then locations will only be updated if the minimum update interval has
expired since the last location update.

**Note:** Some allowance for jitter is already built into the
minimum update interval, so you need not worry about updates blocked simply because they
arrived a fraction of a second earlier than expected.

<br />

| Returns ||
|---|---|
| `long` | the minimum update interval. Value is 0 or greater <br /> |

### getQuality

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getQuality ()
```

Returns the quality hint for this location request. The quality hint informs the provider how
it should attempt to manage any accuracy vs power tradeoffs while attempting to satisfy this
location request.

<br />

| Returns ||
|---|---|
| `int` | the desired quality tradeoffs between accuracy and power. Value is one of the following: - `https://developer.android.com/reference/android/location/LocationRequest#QUALITY_LOW_POWER` - `https://developer.android.com/reference/android/location/LocationRequest#QUALITY_BALANCED_POWER_ACCURACY` - `https://developer.android.com/reference/android/location/LocationRequest#QUALITY_HIGH_ACCURACY` |

### hashCode

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.


The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### writeToParcel

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel parcel, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `parcel` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |