public class

LocationRequestOptions

extends Object
implements Parcelable JsonSerializable
java.lang.Object
   ↳ com.urbanairship.location.LocationRequestOptions

Class Overview

High level location requirements to be used for UALocationManager and service.

The class is modeled after the LocationRequest for the Fused Location Provider, but only supports a subset of the options.

Summary

Nested Classes
class LocationRequestOptions.Builder Builder to construct LocationRequestOptions. 
@interface LocationRequestOptions.Priority  
Constants
int DEFAULT_REQUEST_PRIORITY Default priority - PRIORITY_BALANCED_POWER_ACCURACY.
float DEFAULT_UPDATE_INTERVAL_METERS Default minDistance in meters - 800 meters.
long DEFAULT_UPDATE_INTERVAL_MILLISECONDS Default minTime in milliseconds - 5 minutes.
String MIN_DISTANCE_KEY JSON key for the min distance.
String MIN_TIME_KEY JSON key for the min time.
int PRIORITY_BALANCED_POWER_ACCURACY Used with setPriority(int) to request balanced power and accuracy.
int PRIORITY_HIGH_ACCURACY Used with setPriority(int) to request highest level of accuracy.
String PRIORITY_KEY JSON key for the request priority.
int PRIORITY_LOW_POWER Used with setPriority(int) to request low power location updates.
int PRIORITY_NO_POWER Used with setPriority(int) to request location that requires no extra power consumption.
[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Methods
static LocationRequestOptions createDefaultOptions()
Creates default request options with DEFAULT_REQUEST_PRIORITY, DEFAULT_UPDATE_INTERVAL_MILLISECONDS, and DEFAULT_UPDATE_INTERVAL_METERS.
int describeContents()
boolean equals(Object o)
static LocationRequestOptions fromJson(JsonValue value)
Creates a LocationRequestOptions from a JSON string.
float getMinDistance()
The minimum distance of meters between location updates.
long getMinTime()
The minimum time in milliseconds between location updates in milliseconds.
int getPriority()
The priority of the request.
static LocationRequestOptions.Builder newBuilder()
Builder factory method.
static LocationRequestOptions parseJson(String json)
This method is deprecated. To be removed in SDK 12. Use fromJson(JsonValue) instead.
JsonValue toJsonValue()
Returns the objects represented as a JsonValue.
String toString()
void writeToParcel(Parcel dest, int flags)
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable
From interface com.urbanairship.json.JsonSerializable

Constants

public static final int DEFAULT_REQUEST_PRIORITY

Default priority - PRIORITY_BALANCED_POWER_ACCURACY.

Constant Value: 2 (0x00000002)

public static final float DEFAULT_UPDATE_INTERVAL_METERS

Default minDistance in meters - 800 meters.

Constant Value: 800.0

public static final long DEFAULT_UPDATE_INTERVAL_MILLISECONDS

Default minTime in milliseconds - 5 minutes.

Constant Value: 300000 (0x00000000000493e0)

public static final String MIN_DISTANCE_KEY

JSON key for the min distance.

Constant Value: "minDistance"

public static final String MIN_TIME_KEY

JSON key for the min time.

Constant Value: "minTime"

public static final int PRIORITY_BALANCED_POWER_ACCURACY

Used with setPriority(int) to request balanced power and accuracy.

When used with the fused location provider it will use "block" level accuracy, about 100 meter accuracy.

When used with standard android location it will use Criteria.ACCURACY_COARSE and Criteria.POWER_MEDIUM.

Constant Value: 2 (0x00000002)

public static final int PRIORITY_HIGH_ACCURACY

Used with setPriority(int) to request highest level of accuracy.

When used with the fused location provider it will request the highest level of accuracy available.

When used with standard android location it will use Criteria.ACCURACY_FINE and Criteria.POWER_HIGH.

Constant Value: 1 (0x00000001)

public static final String PRIORITY_KEY

JSON key for the request priority.

Constant Value: "priority"

public static final int PRIORITY_LOW_POWER

Used with setPriority(int) to request low power location updates.

When used with the fused location provider it will use "city" level accuracy, about 10km accuracy.

When used with standard android location it will use Criteria.ACCURACY_COARSE and Criteria.POWER_LOW.

Constant Value: 3 (0x00000003)

public static final int PRIORITY_NO_POWER

Used with setPriority(int) to request location that requires no extra power consumption.

Warning: When used with the standard android location it will only use the PASSIVE provider if available. The passive provider requires ACCESS_FINE_LOCATION permission. If either the provider is missing or missing permissions location will not be gathered.

Constant Value: 4 (0x00000004)

Public Methods

public static LocationRequestOptions createDefaultOptions ()

Creates default request options with DEFAULT_REQUEST_PRIORITY, DEFAULT_UPDATE_INTERVAL_MILLISECONDS, and DEFAULT_UPDATE_INTERVAL_METERS.

Returns
  • Default location request options.

public int describeContents ()

public boolean equals (Object o)

public static LocationRequestOptions fromJson (JsonValue value)

Creates a LocationRequestOptions from a JSON string.

Parameters
value The JSON value.
Returns
  • The parsed LocationRequestOptions.
Throws
JsonException If the JSON is invalid.

public float getMinDistance ()

The minimum distance of meters between location updates.

Returns
  • The minimum distance of meters between location updates.

public long getMinTime ()

The minimum time in milliseconds between location updates in milliseconds.

Returns
  • The desired interval for location updates in milliseconds.

public int getPriority ()

The priority of the request.

Returns
  • The priority of the request.

public static LocationRequestOptions.Builder newBuilder ()

Builder factory method.

Returns
  • A new builder instance.

public static LocationRequestOptions parseJson (String json)

This method is deprecated.
To be removed in SDK 12. Use fromJson(JsonValue) instead.

Parameters
json The json value.
Returns
  • The parsed LocationRequestOptions.
Throws
JsonException If the JSON is invalid.
See Also

public JsonValue toJsonValue ()

Returns the objects represented as a JsonValue.

Returns
  • The object as a JsonValue.

public String toString ()

public void writeToParcel (Parcel dest, int flags)