es.situm.sdk.location

Class LocationRequest

java.lang.Object

es.situm.sdk.location.LocationRequest

All Implemented Interfaces:

android.os.Parcelable

public class LocationRequest
extends Object
implements android.os.Parcelable

A data object that contains parameters for the location service, LocationManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationRequest.Builder
static class	LocationRequest.IndoorProvider The indoor provider used for positioning
static class	LocationRequest.MotionMode Positioning motion mode
static class	LocationRequest.RealtimeUpdateInterval Realtime locations update intervals

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<LocationRequest>	CREATOR
static LocationRequest.IndoorProvider	DEFAULT_INDOOR_PROVIDER Default indoor provider
static int	DEFAULT_INTERVAL Default interval (in milliseconds) to notify location updates
static LocationRequest.MotionMode	DEFAULT_MOTION_MODE Default motion mode
static LocationRequest.RealtimeUpdateInterval	DEFAULT_REALTIME_UPDATE_INTERVAL Default interval (in milliseconds) to send locations to the Realtime
static float	DEFAULT_SMALLEST_DISPLACEMENT Default smallest displacement to nofiy location updates

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
List<BeaconFilter>	getBeaconFilters() Gets the list of beacon UUIDs that are asigned to this location request.
String	getBuildingIdentifier()
android.app.Notification	getForegroundServiceNotification()
LocationRequest.IndoorProvider	getIndoorProvider()
int	getInterval()
LocationRequest.MotionMode	getMotionMode()
OutdoorLocationOptions	getOutdoorLocationOptions()
LocationRequest.RealtimeUpdateInterval	getRealtimeUpdateInterval()
float	getSmallestDisplacement()
int	hashCode()
void	setRealtimeUpdateInterval(LocationRequest.RealtimeUpdateInterval realtimeUpdateInterval)
String	toString()
boolean	useBatterySaver()
boolean	useBle()
boolean	useDeadReckoning()
boolean	useForegroundService()
boolean	useGlobalLocation() Return true if indoor-outdoor location is enabled, no building identifier has been set.
boolean	useWifi()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_INTERVAL

public static final int DEFAULT_INTERVAL

Default interval (in milliseconds) to notify location updates

See Also:

Constant Field Values

DEFAULT_INDOOR_PROVIDER

public static final LocationRequest.IndoorProvider DEFAULT_INDOOR_PROVIDER

Default indoor provider

DEFAULT_MOTION_MODE

public static final LocationRequest.MotionMode DEFAULT_MOTION_MODE

Default motion mode

DEFAULT_SMALLEST_DISPLACEMENT

public static final float DEFAULT_SMALLEST_DISPLACEMENT

Default smallest displacement to nofiy location updates

See Also:

Constant Field Values

DEFAULT_REALTIME_UPDATE_INTERVAL

public static final LocationRequest.RealtimeUpdateInterval DEFAULT_REALTIME_UPDATE_INTERVAL

Default interval (in milliseconds) to send locations to the Realtime

CREATOR

public static final android.os.Parcelable.Creator<LocationRequest> CREATOR

Method Detail

getBuildingIdentifier

public String getBuildingIdentifier()

getInterval

public int getInterval()

getIndoorProvider

public LocationRequest.IndoorProvider getIndoorProvider()

useBle

public boolean useBle()

useWifi

public boolean useWifi()

useBatterySaver

public boolean useBatterySaver()

getSmallestDisplacement

public float getSmallestDisplacement()

getMotionMode

public LocationRequest.MotionMode getMotionMode()

useDeadReckoning

public boolean useDeadReckoning()

useForegroundService

public boolean useForegroundService()

getForegroundServiceNotification

public android.app.Notification getForegroundServiceNotification()

getOutdoorLocationOptions

public OutdoorLocationOptions getOutdoorLocationOptions()

useGlobalLocation

public boolean useGlobalLocation()

Return true if indoor-outdoor location is enabled, no building identifier has been set. False if indoor mode is enabled

See Also:

setBuildingIdentifier(String)

getBeaconFilters

public List<BeaconFilter> getBeaconFilters()

Gets the list of beacon UUIDs that are asigned to this location request. This beacon UUIDs will be used for filter the UUIDs during ble scaning.

Returns:

list of beacon UUIDs

setRealtimeUpdateInterval

public void setRealtimeUpdateInterval(LocationRequest.RealtimeUpdateInterval realtimeUpdateInterval)

getRealtimeUpdateInterval

public LocationRequest.RealtimeUpdateInterval getRealtimeUpdateInterval()

toString

public String toString()

Overrides:

toString in class Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object