com.indooratlas.android.sdk

Class IALocationRequest

java.lang.Object

com.indooratlas.android.sdk.IALocationRequest

All Implemented Interfaces:

Parcelable

public final class IALocationRequest
extends Object
implements Parcelable

Provides quality of service attributes to the IALocationManager. Currently an empty instance obtained with create() can be used.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<IALocationRequest>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
static IALocationRequest	create()
int	describeContents()
long	getFastestInterval() Get fastest interval of this request, in milliseconds.
<T extends Parcelable> T	getParcelableExtra(String key)
float	getSmallestDisplacement() Get smallest displacement for location updates to trigger, in meters.
String	getStringExtra(String key)
IALocationRequest	putExtra(String key, Parcelable value)
IALocationRequest	putExtra(String key, String value)
IALocationRequest	setFastestInterval(long millis) Explicitly set the fastest interval for location updates, in milliseconds.
IALocationRequest	setSmallestDisplacement(float meters) Set the minimum displacement between location updates in meters.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<IALocationRequest> CREATOR

Method Detail

create

public static IALocationRequest create()

putExtra

public IALocationRequest putExtra(String key,
                                  String value)

putExtra

public IALocationRequest putExtra(String key,
                                  Parcelable value)

getStringExtra

public String getStringExtra(String key)

setFastestInterval

public IALocationRequest setFastestInterval(long millis)

Explicitly set the fastest interval for location updates, in milliseconds.

This controls the fastest rate at which your application will receive location updates. The actual rate can be slower than requested but no faster than requested.

Requesting updates faster has only minimal impact on battery consumption and will not cause extra network load.

There is now lower limit on the frequency but using a very small value may effect your application performance.

If no value is set, the default value is 5Hz, i.e. 200ms

getFastestInterval

public long getFastestInterval()

Get fastest interval of this request, in milliseconds.
SDK will never provide updates faster than getFastestInterval(). Actual frequency may be slower.

Returns:

fastest interval in milliseconds or -1 if value was not set

setSmallestDisplacement

public IALocationRequest setSmallestDisplacement(float meters)

Set the minimum displacement between location updates in meters.

This controls how often your application will receive location updates. User needs to move specified distance for the IALocationListener.onLocationChanged(IALocation) to trigger. First update will always be delivered as soon as one is available.

Requesting updates faster has only minimal impact on battery consumption and will not cause extra network load.

getSmallestDisplacement

public float getSmallestDisplacement()

Get smallest displacement for location updates to trigger, in meters.

Returns:

minimum displacement between location updates in meters or -1 if not set.

getParcelableExtra

public <T extends Parcelable> T getParcelableExtra(String key)

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable