location/com.splendo.kaluga.location/BaseLocationManager/Settings

Settings

data class Settings(val locationPermission: LocationPermission, val permissions: Permissions, val autoRequestPermission: Boolean = true, val autoEnableLocations: Boolean = true, val locationBufferCapacity: Int = 16, val minUpdateDistanceMeters: Float = 0.0f, val logger: Logger = RestrictedLogger(RestrictedLogLevel.None))

Settings to configure a BaseLocationManager

Parameters

locationBufferCapacity

the maximum number of location that can be buffered, if exceed oldest is dropped

minUpdateDistanceMeters

the minimum distance in meters that a location needs to change compared to the last result for a location update to trigger

logger

the Logger to use for logging

Constructors

Settings

constructor(locationPermission: LocationPermission, permissions: Permissions, autoRequestPermission: Boolean = true, autoEnableLocations: Boolean = true, locationBufferCapacity: Int = 16, minUpdateDistanceMeters: Float = 0.0f, logger: Logger = RestrictedLogger(RestrictedLogLevel.None))

Properties

autoEnableLocations

val autoEnableLocations: Boolean = true

if true the location manager should automatically enable the location service if disabled

autoRequestPermission

val autoRequestPermission: Boolean = true

if true the location manager should automatically request permissions if not granted

locationBufferCapacity

val locationBufferCapacity: Int = 16

locationPermission

val locationPermission: LocationPermission

The LocationPermission to use for monitoring location changes. If passing your own settings pass LocationPermission returned from settingsBuilder when you call BaseLocationStateRepoBuilder.create

logger

val logger: Logger

minUpdateDistanceMeters

val minUpdateDistanceMeters: Float = 0.0f

permissions

val permissions: Permissions

The Permissions managing the location permission. If passing your own settings pass permissions returned from settingsBuilder when you call BaseLocationStateRepoBuilder.create