Added in API level 31

LocationRequest


class LocationRequest : Parcelable
kotlin.Any
   ↳ android.location.LocationRequest

An encapsulation of various parameters for requesting location via LocationManager.

Summary

Nested classes

A builder class for LocationRequest.

Constants
static Long

Represents a passive only request.

static Int

A quality constant indicating a location provider may choose to satisfy this request by equally balancing power and accuracy constraints.

static Int

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.

static Int

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
Public methods
Int

Boolean
equals(other: Any?)

Long

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

Long

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

Long

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

Int

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

Float

Returns the minimum distance between location updates.

Long

Returns the minimum update interval.

Int

Returns the quality hint for this location request.

Int

String

Returns a string representation of the object.

Unit
writeToParcel(parcel: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<LocationRequest!>

Constants

PASSIVE_INTERVAL

Added in API level 31
static val PASSIVE_INTERVAL: Long

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.

Value: 9223372036854775807L

QUALITY_BALANCED_POWER_ACCURACY

Added in API level 31
static val QUALITY_BALANCED_POWER_ACCURACY: Int

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.

Value: 102

QUALITY_HIGH_ACCURACY

Added in API level 31
static val QUALITY_HIGH_ACCURACY: Int

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.

Value: 100

QUALITY_LOW_POWER

Added in API level 31
static val QUALITY_LOW_POWER: Int

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.

Value: 104

Public methods

describeContents

Added in API level 31
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getDurationMillis

Added in API level 31
fun getDurationMillis(): Long

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.

Return
Long the duration for which location will be provided Value is 1 or greater

getIntervalMillis

Added in API level 31
fun getIntervalMillis(): Long

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.

Return
Long the desired interval of location updates Value is 0 or greater

getMaxUpdateDelayMillis

Added in API level 31
fun getMaxUpdateDelayMillis(): Long

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.

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

getMaxUpdates

Added in API level 31
fun getMaxUpdates(): Int

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.

Return
Int Value is between 1 and Integer.MAX_VALUE inclusive

getMinUpdateDistanceMeters

Added in API level 31
fun getMinUpdateDistanceMeters(): Float

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.

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

getMinUpdateIntervalMillis

Added in API level 31
fun getMinUpdateIntervalMillis(): Long

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.

Return
Long the minimum update interval Value is 0 or greater

getQuality

Added in API level 31
fun getQuality(): Int

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.

Return
Int the desired quality tradeoffs between accuracy and power Value is android.location.LocationRequest#QUALITY_LOW_POWER, android.location.LocationRequest#QUALITY_BALANCED_POWER_ACCURACY, or android.location.LocationRequest#QUALITY_HIGH_ACCURACY

hashCode

Added in API level 31
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 31
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.

writeToParcel

Added in API level 31
fun writeToParcel(
    parcel: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
parcel Parcel: This value cannot be null.

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<LocationRequest!>