location/com.splendo.kaluga.location

Package-level declarations

Types

AppleLocationSettings

expect class AppleLocationSettings

Platform-specific configuration for the Apple DefaultLocationManager, passed to its DefaultLocationManager.Builder.

actual class AppleLocationSettings

Platform-specific configuration for the Apple DefaultLocationManager, passed to its DefaultLocationManager.Builder.

actual class AppleLocationSettings

Platform-specific configuration for the Apple DefaultLocationManager, passed to its DefaultLocationManager.Builder.

actual class AppleLocationSettings

tvOS AppleLocationSettings.

actual class AppleLocationSettings

Platform-specific configuration for the Apple DefaultLocationManager, passed to its DefaultLocationManager.Builder.

BaseLocationManager

abstract class BaseLocationManager(settings: BaseLocationManager.Settings, coroutineScope: CoroutineScope) : LocationManager, CoroutineScope

An abstract implementation for LocationManager

BaseLocationStateRepo

abstract class BaseLocationStateRepo(createNotInitializedState: () -> LocationState.NotInitialized, createInitializingState: suspend ColdStateFlowRepo<LocationState>.(LocationState.Inactive) -> suspend () -> LocationState.Initializing, createDeinitializingState: suspend ColdStateFlowRepo<LocationState>.(LocationState.Active) -> suspend () -> LocationState.Deinitialized, coroutineContext: CoroutineContext) : ColdStateFlowRepo<LocationState>

An abstract ColdStateFlowRepo for managing LocationState

BaseLocationStateRepoBuilder

interface BaseLocationStateRepoBuilder

Builder for creating a LocationStateRepo

DefaultLocationManager

actual class DefaultLocationManager : BaseLocationManager

A default implementation of BaseLocationManager

actual class DefaultLocationManager : BaseLocationManager

A default implementation of BaseLocationManager

expect class DefaultLocationManager : BaseLocationManager

A default implementation of BaseLocationManager

actual class DefaultLocationManager : BaseLocationManager

A default implementation of BaseLocationManager for the JS family (js + wasmJs), backed by the browser Geolocation API via watchPosition. Background updates and programmatic enabling are not available on the web.

DefaultLocationMonitor

class DefaultLocationMonitor(applicationContext: Context, locationManager: LocationManager?) : DefaultServiceMonitor, LocationMonitor

Default implementation of LocationMonitor

class DefaultLocationMonitor(locationManager: CLLocationManager) : DefaultServiceMonitor, LocationMonitor

Default implementation of LocationMonitor

class DefaultLocationMonitor : DefaultServiceMonitor, LocationMonitor

Default LocationMonitor for the JS family. The browser exposes location whenever navigator.geolocation is present; there is no runtime enable/disable signal to observe.

data class DMSCoordinate(val degrees: Int, val minutes: Int, val seconds: Double, val windDirection: DMSCoordinate.WindDirection)

A Location coordinate defined by degrees, minutes and seconds.

GoogleLocationProvider

class GoogleLocationProvider(context: Context, settings: GoogleLocationProvider.Settings, minUpdateDistanceMeters: Float) : LocationProvider

A LocationProvider using the Google Location Services

GoogleLocationUpdatesBroadcastReceiver

class GoogleLocationUpdatesBroadcastReceiver : BroadcastReceiver

A BroadcastReceiver for receiving updates to a Google Location from the background

sealed class Location

A Geolocation of the system

LocationManager

interface LocationManager

Manages monitoring for Location

LocationMonitor

actual interface LocationMonitor : ServiceMonitor

A ServiceMonitor that monitors whether the location service is enabled

actual interface LocationMonitor : ServiceMonitor

A ServiceMonitor that monitors whether the location service is enabled

expect interface LocationMonitor : ServiceMonitor

A ServiceMonitor that monitors whether the location service is enabled

actual interface LocationMonitor : ServiceMonitor

A ServiceMonitor that monitors whether the location service is enabled, shared by the JS family.

LocationProvider

interface LocationProvider

A provider of Location.KnownLocation

sealed interface LocationState : KalugaState

A KalugaState of a Location

LocationStateFlowRepo

typealias LocationStateFlowRepo = StateRepo<LocationState, MutableStateFlow<LocationState>>

A StateRepo/MutableStateFlow of LocationState

LocationStateImplRepo

open class LocationStateImplRepo(createLocationManager: suspend () -> LocationManager, coroutineContext: CoroutineContext) : BaseLocationStateRepo

A BaseLocationStateRepo managed using a LocationManager

LocationStateRepo

class LocationStateRepo(settingsBuilder: suspend (CoroutineContext) -> BaseLocationManager.Settings, builder: BaseLocationManager.Builder, coroutineContext: CoroutineContext) : LocationStateImplRepo

A LocationStateImplRepo using a BaseLocationManager

LocationStateRepoBuilder

actual class LocationStateRepoBuilder : BaseLocationStateRepoBuilder

Default BaseLocationStateRepoBuilder

actual class LocationStateRepoBuilder : BaseLocationStateRepoBuilder

Default BaseLocationStateRepoBuilder

expect class LocationStateRepoBuilder : BaseLocationStateRepoBuilder

Default BaseLocationStateRepoBuilder

actual class LocationStateRepoBuilder : BaseLocationStateRepoBuilder

Default BaseLocationStateRepoBuilder for the JS family.

Properties

val Location.known: Location.KnownLocation?

Gets the Location.KnownLocation from a Location if it exists. Otherwise null is returned

val CLLocation.knownLocation: Location.KnownLocation

The Location.KnownLocation of a CLLocation

val Location.KnownLocation?.orUnknown: Location

Converts a Nullable Location.KnownLocation into a Location, where Location.UnknownLocation.WithoutLastLocation is returned if the location was null.

Functions

fun Flow<Location>.known(maxAge: Duration = 0.seconds): Flow<Location.KnownLocation?>

Transforms a Flow of LocationState into a flow of its associated optional Location.KnownLocation

fun Flow<LocationState>.location(): Flow<Location>

Transforms a Flow of LocationState into a flow of its associated Location

toKnownLocation

fun Location.toKnownLocation(): Location.KnownLocation

Converts a android.location.Location into a Location.KnownLocation

toKnownLocations

fun LocationResult.toKnownLocations(): List<Location.KnownLocation>

Converts a LocationResult to a list of Location.KnownLocation

unknownLocationOf

fun Location.unknownLocationOf(reason: Location.UnknownLocation.Reason): Location.UnknownLocation

Converts a Location into a Location.UnknownLocation given a Location.UnknownLocation.Reason