LocationRequest

public final class LocationRequest
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.LocationRequest


An encapsulation of various parameters for requesting location via LocationManager.

Summary

Nested classes

class LocationRequest.Builder

A builder class for LocationRequest

Constants

long PASSIVE_INTERVAL

Represents a passive only request.

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.

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.

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.

Inherited constants

Fields

public static final Creator<LocationRequest> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

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

long getDurationMillis()

Returns the duration for which location will be provided before the request is automatically removed.

long getIntervalMillis()

Returns the desired interval of location updates, or PASSIVE_INTERVAL if this is a passive, no power request.

long getMaxUpdateDelayMillis()

Returns the maximum time any location update may be delayed, and thus grouped with following updates to enable location batching.

int getMaxUpdates()

Returns the maximum number of location updates for this request before the request is automatically removed.

float getMinUpdateDistanceMeters()

Returns the minimum distance between location updates.

long getMinUpdateIntervalMillis()

Returns the minimum update interval.

int getQuality()

Returns the quality hint for this location request.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

PASSIVE_INTERVAL

Added in API level 31
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.

Constant Value: 9223372036854775807 (0x7fffffffffffffff)

QUALITY_BALANCED_POWER_ACCURACY

Added in API level 31
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.

Constant Value: 102 (0x00000066)

QUALITY_HIGH_ACCURACY

Added in API level 31
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.

Constant Value: 100 (0x00000064)

QUALITY_LOW_POWER

Added in API level 31
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.

Constant Value: 104 (0x00000068)

Fields

CREATOR

Added in API level 31
public static final Creator<LocationRequest> CREATOR

Public methods

describeContents

Added in API level 31
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 writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31
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.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDurationMillis

Added in API level 31
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.

Returns
long the duration for which location will be provided Value is 1 or greater

getIntervalMillis

Added in API level 31
public long getIntervalMillis ()

Returns the desired interval of location updates, or 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 getMinUpdateIntervalMillis() for the behavior in that case.

Returns
long the desired interval of location updates Value is 0 or greater

getMaxUpdateDelayMillis

Added in API level 31
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.

Returns
long the maximum time by which a location update may be delayed Value is 0 or greater

getMaxUpdates

Added in API level 31
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.

Returns
int Value is between 1 and Integer.MAX_VALUE inclusive

getMinUpdateDistanceMeters

Added in API level 31
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.

Returns
float the minimum distance between location updates Value is between 0 and Float.MAX_VALUE inclusive

getMinUpdateIntervalMillis

Added in API level 31
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.

Returns
long the minimum update interval Value is 0 or greater

getQuality

Added in API level 31
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.

Returns
int the desired quality tradeoffs between accuracy and power Value is QUALITY_LOW_POWER, QUALITY_BALANCED_POWER_ACCURACY, or QUALITY_HIGH_ACCURACY

hashCode

Added in API level 31
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 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 equals 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 equals 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.

Returns
int a hash code value for this object.

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 31
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES