Most visited

Recently visited

Results for

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

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: 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 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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

PASSIVE_INTERVAL

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.

See also:

getIntervalMillis()

Constant Value: 9223372036854775807 (0x7fffffffffffffff)

QUALITY_BALANCED_POWER_ACCURACY

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

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

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

public static final Creator<LocationRequest> CREATOR

Public methods

describeContents

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

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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

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

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

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

See also:

LocationListener.onLocationChanged(java.util.List)

getMaxUpdates

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

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

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

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

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(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 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	This value cannot be `null`.

writeToParcel

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

Most visited

Recently visited

Results for

LocationRequest

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

PASSIVE_INTERVAL

QUALITY_BALANCED_POWER_ACCURACY

QUALITY_HIGH_ACCURACY

QUALITY_LOW_POWER

Fields

CREATOR

Public methods

describeContents

equals

getDurationMillis

getIntervalMillis

getMaxUpdateDelayMillis

getMaxUpdates

getMinUpdateDistanceMeters

getMinUpdateIntervalMillis

getQuality

hashCode

toString

writeToParcel