LocationRequest.Builder (Situm Android SDK 2.33.0)

java.lang.Object
- es.situm.sdk.location.LocationRequest.Builder

Enclosing class:: LocationRequest

public static final class LocationRequest.Builder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Builder(LocationRequest copy)

Constructors
Constructor and Description
`Builder()`
`Builder(LocationRequest copy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LocationRequest.Builder`	`addBeaconFilter(BeaconFilter beaconFilter)` Adds a beacon filter to be handled during scan time, otherwise only Situm beacons will be scanned.
`LocationRequest.Builder`	`addBeaconFilters(java.util.List<BeaconFilter> beaconFilters)` Adds beacon filters to be handled during scan time, otherwise only Situm beacons will be scanned.
`LocationRequest.Builder`	`autoEnableBleDuringPositioning(java.lang.Boolean autoEnableBleDuringPositioning)` Set if the BLE should be re-enabled during positioning if the ble is used (see `useBle(boolean)`.
`LocationRequest`	`build()`
`LocationRequest.Builder`	`buildingIdentifier(java.lang.String buildingIdentifier)` Set the building identifier of the building where you will start positioning.
`LocationRequest.Builder`	`foregroundServiceNotification(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 desired interval for location updates, in milliseconds.This interval is inexact, the service will try to obtain location updates for your application at this interval.
`LocationRequest.Builder`	`motionMode(LocationRequest.MotionMode motionMode)` (EXPERIMENTAL) Set the motion mode.
`LocationRequest.Builder`	`outdoorLocationOptions(OutdoorLocationOptions outdoorLocationOptions)` Set outdoor location options.
`LocationRequest.Builder`	`realtimeUpdateInterval(LocationRequest.RealtimeUpdateInterval realtimeUpdateInterval)` Set the interval to upload locations to the realtime.
`LocationRequest.Builder`	`smallestDisplacement(float smallestDisplacement)` Set the minimum displacement between location updates (in meters).
`LocationRequest.Builder`	`useBatterySaver(java.lang.Boolean useBatterySaver)` (EXPERIMENTAL) This option enables battery saving when device is idle and not moving.
`LocationRequest.Builder`	`useBle(boolean useBle)` Set if you want to use BLE for positioning.
`LocationRequest.Builder`	`useCompass(boolean useCompass)` Set if you want to use compass 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)` Run the service in foreground.
`LocationRequest.Builder`	`useGps(boolean useGps)` (EXPERIMENTAL) Set if you want to use Gps for positioning indoor.
`LocationRequest.Builder`	`useGyro(boolean useGyro)` Set if you want to use gyro for positioning.
`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(java.lang.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. Indoor-outdoor mode requires the permission android.permission.ACCESS_FINE_LOCATION. In Android 9 the location does not have modes, is just enabled or disabled but before Android 9 there were three location modes: High accuracy, Battery saving and device only. To use the indoor-outdoor location the user must set the location mode to High Accuracy. Otherwise the location won't start if the device can't get an outdoor position. The High Accuracy mode uses GPS, Wi-Fi, Bluetooth and mobile networks to get the location. This mode will return the most accurate location possible The Battery Saving mode uses Wi-Fi, Bluetooth and mobile networks. It does not use GPS so the positioning won't work because the indoor-outdoor mode needs the GPS signal to be available. The Device Only mode uses the GPS, so the positioning will not start if there is no GPS signal. You can know more about the location modes [here](https://developer.android.com/training/location/change-location-settings#location-request)
  - interval
```
public LocationRequest.Builder interval(int interval)
```
    Set the desired interval for location updates, in milliseconds.This interval is inexact, the service will try to obtain location updates for your application at this interval.
    Keep in mind that if you set a custom value for smallestDisplacement(float) you may not receive updates at the desired interval if the other condition isn't met.
    If this value is set the Dead Reckoning (useDeadReckoning(boolean) will be disabled. Default value is LocationRequest.DEFAULT_INTERVAL
  - indoorProvider
```
public LocationRequest.Builder indoorProvider(LocationRequest.IndoorProvider indoorProvider)
```
    Set the indoor location provider. Default value is LocationRequest.IndoorProvider.INPHONE
  - useBle
```
public LocationRequest.Builder useBle(boolean useBle)
```
    Set if you want to use BLE for positioning. Default value is true.
    To scan BLE the BLE should be enabled. When the positioning is started the sensor is enabled automatically. Then, during positioning, if the user disables the BLE it will be re-enabled automatically, if you want to change this behaviour see autoEnableBleDuringPositioning(Boolean).
  - useWifi
```
public LocationRequest.Builder useWifi(boolean useWifi)
```
    Set if you want to use Wifi for positioning. Default value is true
  - useCompass
```
public LocationRequest.Builder useCompass(boolean useCompass)
```
    Set if you want to use compass for positioning. It's highly recommended to use the compass and only should be disabled if the sensor is not working properly. Default value is true.
    Gyro and compass shouldn't be disabled at the same time.
  - useGyro
```
public LocationRequest.Builder useGyro(boolean useGyro)
```
    Set if you want to use gyro for positioning. It's highly recommended to use the gyro and only should be disabled if the sensor is not working properly. Default value is true.
    Gyro and compass shouldn't be disabled at the same time.
  - useGps
```
public LocationRequest.Builder useGps(boolean useGps)
```
    (EXPERIMENTAL) Set if you want to use Gps for positioning indoor. It requires the permission android.permission.ACCESS_FINE_LOCATION.
  - 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)
```
    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 foregroundServiceNotification(Notification)
    
    Parameters:
    
    useForegroundService - true to run the service in foreground, false otherwise
    
    See Also:
    
    Using Situm SDK in the background
  - 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(Notification foregroundServiceNotification)
```
    Set the notification used if the service is running in foreground. Used only if useForegroundService(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
  - addBeaconFilter
```
public LocationRequest.Builder addBeaconFilter(BeaconFilter beaconFilter)
```
    Adds a beacon filter to be handled during scan time, otherwise only Situm beacons will be scanned. Can be invoked multiple times to add as much beacon filters as you want
  - addBeaconFilters
```
public LocationRequest.Builder addBeaconFilters(java.util.List<BeaconFilter> beaconFilters)
```
    Adds beacon filters to be handled during scan time, otherwise only Situm beacons will be scanned. Can be invoked multiple times to add as much beacon filters as you want
  - useBatterySaver
```
public LocationRequest.Builder useBatterySaver(java.lang.Boolean useBatterySaver)
```
    (EXPERIMENTAL) This option enables battery saving when device is idle and not moving. The positioning will be stopped while idle but it will still be visible in the Dashboard Realtime. Default value is false
  - smallestDisplacement
```
public LocationRequest.Builder smallestDisplacement(float smallestDisplacement)
```
    Set the minimum displacement between location updates (in meters). The default value is LocationRequest.DEFAULT_SMALLEST_DISPLACEMENT.
    Keep in mind that if you set a custom value for interval(int) you may not receive updates at the desired interval if the other condition isn't met.
    If this value is set the Dead Reckoning (useDeadReckoning(boolean) will be disabled.
    
    Parameters:
    
    smallestDisplacement - the smallest displacement (in meters) the user must move between location updates
  - realtimeUpdateInterval
```
public LocationRequest.Builder realtimeUpdateInterval(LocationRequest.RealtimeUpdateInterval realtimeUpdateInterval)
```
    Set the interval to upload locations to the realtime.
    
    Parameters:
    
    realtimeUpdateInterval - the interval to upload locations to the realtime
  - autoEnableBleDuringPositioning
```
public LocationRequest.Builder autoEnableBleDuringPositioning(java.lang.Boolean autoEnableBleDuringPositioning)
```
    Set if the BLE should be re-enabled during positioning if the ble is used (see useBle(boolean). Default value is true.
    The BLE sensor will still be enabled when you start the positioning using BLE.
  - build
```
public LocationRequest build()
```

Class LocationRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

buildingIdentifier

interval

indoorProvider

useBle

useWifi

useCompass

useGyro

useGps

motionMode

useForegroundService

useDeadReckoning

foregroundServiceNotification

outdoorLocationOptions

addBeaconFilter

addBeaconFilters

useBatterySaver

smallestDisplacement

realtimeUpdateInterval

autoEnableBleDuringPositioning

build