es.situm.sdk.location

Class LocationRequest.Builder

java.lang.Object

es.situm.sdk.location.LocationRequest.Builder

Enclosing class:

LocationRequest

public static final class LocationRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(LocationRequest copy)

Method Summary

Modifier and Type	Method and Description
LocationRequest	build()
LocationRequest.Builder	buildingIdentifier(String buildingIdentifier) Set the building identifier of the building where you will start positioning.
LocationRequest.Builder	foregroundServiceNotification(android.app.Notification foregroundServiceNotification) Set the notification used if the service is running in foreground.
LocationRequest.Builder	indoorProvider(LocationRequest.IndoorProvider indoorProvider) Set the indoor location provider.
LocationRequest.Builder	interval(int interval) Set the interval in which the locations will be send to the server (in milliseconds) in Cloud mode.
LocationRequest.Builder	motionMode(LocationRequest.MotionMode motionMode) (EXPERIMENTAL) Set the motion mode.
LocationRequest.Builder	outdoorLocationOptions(OutdoorLocationOptions outdoorLocationOptions) Set outdoor location options.
LocationRequest.Builder	useBle(boolean useBle) Set if you want to use BLE for positioning.
LocationRequest.Builder	useDeadReckoning(boolean useDeadReckoning) (EXPERIMENTAL) Set if you want to use dead reckoning to get fast position updates using only the inertial sensors, between the server position updates.
LocationRequest.Builder	useForegroundService(boolean useForegroundService) (EXPERIMENTAL) Run the service in foreground.
LocationRequest.Builder	useWifi(boolean useWifi) Set if you want to use Wifi for positioning.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(LocationRequest copy)

Method Detail

buildingIdentifier

public LocationRequest.Builder buildingIdentifier(String buildingIdentifier)

Set the building identifier of the building where you will start positioning. If this value is not set the positioning will start in indoor-outdoor mode.

interval

public LocationRequest.Builder interval(int interval)

Set the interval in which the locations will be send to the server (in milliseconds) in Cloud mode. This value will be rounded to an integer second In Inphone mode the locations will be computed every second. Default value is 1000

indoorProvider

public LocationRequest.Builder indoorProvider(LocationRequest.IndoorProvider indoorProvider)

Set the indoor location provider. Default value is LocationRequest.IndoorProvider.HYBRID

useBle

public LocationRequest.Builder useBle(boolean useBle)

Set if you want to use BLE for positioning. Default value is true

useWifi

public LocationRequest.Builder useWifi(boolean useWifi)

Set if you want to use Wifi for positioning. Default value is true

motionMode

public LocationRequest.Builder motionMode(LocationRequest.MotionMode motionMode)

(EXPERIMENTAL) Set the motion mode. Default value is LocationRequest.MotionMode.BY_FOOT

useForegroundService

public LocationRequest.Builder useForegroundService(boolean useForegroundService)

(EXPERIMENTAL) Run the service in foreground. By default services are background, meaning that if the system needs to kill them to reclaim more memory they can be killed without too much harm. You can set this option to avoid this. A notification will be shown to the user while is running. You can set this notification with LocationRequest.setForegroundServiceNotification(Notification)

Parameters:

useForegroundService - true to run the service in foreground, false otherwise

useDeadReckoning

public LocationRequest.Builder useDeadReckoning(boolean useDeadReckoning)

(EXPERIMENTAL) Set if you want to use dead reckoning to get fast position updates using only the inertial sensors, between the server position updates.

foregroundServiceNotification

public LocationRequest.Builder foregroundServiceNotification(android.app.Notification foregroundServiceNotification)

Set the notification used if the service is running in foreground. Used only if LocationRequest.setUseForegroundService(Boolean) is true

Parameters:

foregroundServiceNotification - the notification to use running in foreground

outdoorLocationOptions

public LocationRequest.Builder outdoorLocationOptions(OutdoorLocationOptions outdoorLocationOptions)

Set outdoor location options. Only used in an indoor/outdoor request

Parameters:

outdoorLocationOptions - the outdoor location options

See Also:

OutdoorLocationOptions

build

public LocationRequest build()