location-permissions/com.splendo.kaluga.permissions.location

Package-level declarations

Types

BaseLocationPermissionManagerBuilder

interface BaseLocationPermissionManagerBuilder : BasePermissionsBuilder<LocationPermission>

A BasePermissionsBuilder for LocationPermission

DefaultLocationPermissionManager

actual class DefaultLocationPermissionManager : BasePermissionManager<LocationPermission>

The BasePermissionManager to use as a default for LocationPermission

actual class DefaultLocationPermissionManager : BasePermissionManager<LocationPermission>

The default Apple BasePermissionManager for LocationPermission.

expect class DefaultLocationPermissionManager : BasePermissionManager<LocationPermission>

The BasePermissionManager to use as a default for LocationPermission

actual class DefaultLocationPermissionManager : BasePermissionManager<LocationPermission>

The default BasePermissionManager for LocationPermission on the JS family (js + wasmJs).

LocationPermission

data class LocationPermission(val background: Boolean = false, val precise: Boolean = false) : Permission

Permission to access the users Location

LocationPermissionManager

typealias LocationPermissionManager = PermissionManager<LocationPermission>

A PermissionManager for managing LocationPermission

LocationPermissionManagerBuilder

actual class LocationPermissionManagerBuilder : BaseLocationPermissionManagerBuilder

A BaseLocationPermissionManagerBuilder

actual class LocationPermissionManagerBuilder : BaseLocationPermissionManagerBuilder

An Apple BaseLocationPermissionManagerBuilder.

expect class LocationPermissionManagerBuilder : BaseLocationPermissionManagerBuilder

A BaseLocationPermissionManagerBuilder

actual class LocationPermissionManagerBuilder : BaseLocationPermissionManagerBuilder

A BaseLocationPermissionManagerBuilder for the JS family. The context is unused — the browser has no ambient permission context.

LocationPermissionStateRepo

class LocationPermissionStateRepo(locationPermission: LocationPermission, builder: BaseLocationPermissionManagerBuilder, monitoringInterval: Duration = defaultMonitoringInterval, settings: BasePermissionManager.Settings = BasePermissionManager.Settings(), coroutineContext: CoroutineContext) : PermissionStateRepo<LocationPermission>

A PermissionStateRepo for LocationPermission

MainCLLocationManagerAccessor

class MainCLLocationManagerAccessor(onInit: CLLocationManager.() -> Unit)

Accessor to ensure a CLLocationManager is only managed from the Main Thread. Use updateLocationManager to gain access to the LocationManager

Functions

authorizationStatus

expect fun CLLocationManager.authorizationStatus(locationPermission: LocationPermission): ApplePermissionsHelper.AuthorizationStatus

Resolves the current platform authorization status for permission. Implementations differ in OS-version handling, accuracy authorization availability and which platform.CoreLocation.CLAuthorizationStatus values are reachable on the target.

actual fun CLLocationManager.authorizationStatus(locationPermission: LocationPermission): ApplePermissionsHelper.AuthorizationStatus

registerLocationPermission

fun PermissionsBuilder.registerLocationPermission(locationPermissionManagerBuilderBuilder: (PermissionContext) -> BaseLocationPermissionManagerBuilder = ::LocationPermissionManagerBuilder, locationPermissionStateRepoBuilder: (LocationPermission, BaseLocationPermissionManagerBuilder, CoroutineContext) -> PermissionStateRepo<LocationPermission>): BaseLocationPermissionManagerBuilder

fun PermissionsBuilder.registerLocationPermission(locationPermissionManagerBuilderBuilder: (PermissionContext) -> BaseLocationPermissionManagerBuilder = ::LocationPermissionManagerBuilder, monitoringInterval: Duration = PermissionStateRepo.defaultMonitoringInterval, settings: BasePermissionManager.Settings = BasePermissionManager.Settings()): BaseLocationPermissionManagerBuilder

Registers a BaseLocationPermissionManagerBuilder and PermissionStateRepo for LocationPermission to the PermissionsBuilder.register and PermissionsBuilder.registerPermissionStateRepoBuilder respectively Only one builder can be registered.

registerLocationPermissionIfNotRegistered

fun PermissionsBuilder.registerLocationPermissionIfNotRegistered(locationPermissionManagerBuilderBuilder: (PermissionContext) -> BaseLocationPermissionManagerBuilder = ::LocationPermissionManagerBuilder, locationPermissionStateRepoBuilder: (LocationPermission, BaseLocationPermissionManagerBuilder, CoroutineContext) -> PermissionStateRepo<LocationPermission>): BaseLocationPermissionManagerBuilder

fun PermissionsBuilder.registerLocationPermissionIfNotRegistered(locationPermissionManagerBuilderBuilder: (PermissionContext) -> BaseLocationPermissionManagerBuilder = ::LocationPermissionManagerBuilder, monitoringInterval: Duration = PermissionStateRepo.defaultMonitoringInterval, settings: BasePermissionManager.Settings = BasePermissionManager.Settings()): BaseLocationPermissionManagerBuilder

Gets the BaseLocationPermissionManagerBuilder registered If not yet registered, this will register a BaseLocationPermissionManagerBuilder and PermissionStateRepo for LocationPermission to the PermissionsBuilder.register and PermissionsBuilder.registerPermissionStateRepoBuilder respectively