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

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

events

open override val events: Flow<LocationManager.Event>

A Flow of all the Event detected by the location manager

locationPermission

open override val locationPermission: LocationPermission

The LocationPermission used for managing this location. If LocationPermission.precise this will scan location at high accuracy If LocationPermission.background this will monitor location from the background

locations

open override val locations: Flow<Location.KnownLocation>

A Flow of the Location.KnownLocation detected by the location manager

Functions

isLocationEnabled

open override fun isLocationEnabled(): Boolean

If true the location service is currently enabled

requestEnableLocation

abstract suspend fun requestEnableLocation()

Attempts to request the user to enable the location service

startMonitoringLocation

abstract suspend fun startMonitoringLocation()

Starts monitoring for new Location.KnownLocation that will be emitted on the locations flow

startMonitoringLocationEnabled

open suspend override fun startMonitoringLocationEnabled()

Starts monitoring for changes related to the location service being enabled This will result in Event.LocationEnabled and Event.LocationDisabled on the events flow

startMonitoringPermissions

open suspend override fun startMonitoringPermissions()

Starts monitoring for changes to permissions related to locationPermission This will result in Event.PermissionChanged on the events flow

stopMonitoringLocation

abstract suspend fun stopMonitoringLocation()

Stops monitoring for new Location.KnownLocation

stopMonitoringLocationEnabled

open suspend override fun stopMonitoringLocationEnabled()

Stops monitoring for changes related to the location service being enabled

stopMonitoringPermissions

open suspend override fun stopMonitoringPermissions()

Stops monitoring for changes to permissions related to locationPermission