base-permissions/com.splendo.kaluga.permissions.base

Package-level declarations

Types

class AndroidPermissionsManager(context: Context = ApplicationHolder.applicationContext, permissions: Array<String> = emptyArray(), coroutineScope: CoroutineScope, logTag: String = "AndroidPermissionManager", logger: Logger = RestrictedLogger(RestrictedLogLevel.None), onPermissionChanged: AndroidPermissionStateHandler) : CoroutineScope

Convenience class for requesting a Permission and monitoring AndroidPermissionState

AndroidPermissionState

enum AndroidPermissionState : Enum<AndroidPermissionState>

The state of a permission according to the Android System

AndroidPermissionStateHandler

interface AndroidPermissionStateHandler

AuthorizationStatusHandler

interface AuthorizationStatusHandler

Handles changes to AuthorizationStatus

BasePermissionManager

abstract class BasePermissionManager(val permission: P, settings: BasePermissionManager.Settings, coroutineScope: CoroutineScope) : PermissionManager , CoroutineScope

An abstract PermissionManager that ensures events wont be missed

BasePermissionsBuilder

interface BasePermissionsBuilder

Base type for all permissions builders. Each permission component implements a concrete permissions builder and registers it in PermissionsBuilder.register.

BasePermissionStateRepo

abstract class BasePermissionStateRepo(createUninitializedState: () -> PermissionState.Uninitialized, createInitializingState: suspend ColdStateFlowRepo<PermissionState>.(PermissionState.Inactive) -> suspend () -> PermissionState.Initializing, createDeinitializedState: suspend ColdStateFlowRepo<PermissionState>.(PermissionState.Active) -> suspend () -> PermissionState.Deinitialized = { it.deinitialize }, coroutineContext: CoroutineContext) : ColdStateFlowRepo<PermissionState>

An abstract ColdStateFlowRepo for managing PermissionState

CurrentAuthorizationStatusProvider

interface CurrentAuthorizationStatusProvider

Provides the current IOSPermissionsHelper.AuthorizationStatus of a given permission.

DefaultAndroidPermissionStateHandler

class DefaultAndroidPermissionStateHandler(eventChannel: SendChannel<PermissionManager.Event>, logTag: String, logger: Logger) : AndroidPermissionStateHandler

DefaultAuthorizationStatusHandler

class DefaultAuthorizationStatusHandler(eventChannel: <Error class: unknown class><<Error class: unknown class>>, logTag: String, logger: <Error class: unknown class>) : AuthorizationStatusHandler

Default implementation of AuthorizationStatusHandler. Maps AuthorizationStatus to a PermissionManager.Event and sends this to a channel

IOSPermissionsHelper

class IOSPermissionsHelper

Convenience class for checking permissions.

Permission

abstract class Permission

Permissions that can be requested by Kaluga Each permission component should declare subclass of Permission

PermissionContext

actual data class PermissionContext

Android context for creating a BasePermissionsBuilder

expect class PermissionContext

Platform specific context for creating a BasePermissionsBuilder

actual typealias PermissionContext = <Error class: unknown class>

iOS context for creating a BasePermissionsBuilder. Type-alias for NSBundle

actual class PermissionContext

JavaScript context for creating a BasePermissionsBuilder

actual class PermissionContext

Java context for creating a BasePermissionsBuilder

PermissionManager

interface PermissionManager

Manager for handling and monitoring a given Permission

PermissionRefreshScheduler

class PermissionRefreshScheduler(currentAuthorizationStatusProvider: CurrentAuthorizationStatusProvider, authorizationStatusHandler: AuthorizationStatusHandler, coroutineScope: <Error class: unknown class>)

Convenience class for scheduling checks to changes in permission state.

Permissions

class Permissions(builder: PermissionsBuilder, coroutineContext: CoroutineContext = defaultPermissionDispatcher)

Holder class for all the PermissionStateFlowRepo associated with Permission

PermissionsActivity

class PermissionsActivity : AppCompatActivity

An AppCompatActivity responsible for requesting a Permission Use PermissionsActivity.Companion.intent for getting an Intent to this activity

PermissionsBuilder

open class PermissionsBuilder(val context: PermissionContext = defaultPermissionContext)

Builder for providing the proper BasePermissionsBuilder and PermissionStateRepoBuilder for each Permission

PermissionsBuilderError

class PermissionsBuilderError(message: String) : Error

Error when PermissionsBuilder tries to register or access invalid permissions.

PermissionState

interface PermissionState : KalugaState

A KalugaState of a Permission

PermissionStateFlowRepo

typealias PermissionStateFlowRepo = StateRepo<PermissionState, MutableStateFlow<PermissionState>>

A StateRepo/MutableStateFlow of PermissionState

PermissionStateRepo

open class PermissionStateRepo(monitoringInterval: Duration = defaultMonitoringInterval, createPermissionManager: (CoroutineScope) -> PermissionManager, coroutineContext: CoroutineContext) : BasePermissionStateRepo

A BasePermissionStateRepo for managing PermissionState

PermissionStateRepoBuilder

interface PermissionStateRepoBuilder

Interface that takes permission and coroutine contexts and creates BasePermissionStateRepo. Each platform registers PermissionStateRepoBuilder in PermissionsBuilder.registerPermissionStateRepoBuilder.

Properties

defaultPermissionContext

actual val defaultPermissionContext: PermissionContext

expect val defaultPermissionContext: PermissionContext

Default PermissionContext of the system

actual val defaultPermissionContext: PermissionContext

Default PermissionContext of the system

actual val defaultPermissionContext: PermissionContext

Default PermissionContext of the system

actual val defaultPermissionContext: PermissionContext

Default PermissionContext of the system

Functions

request

suspend fun Flow<PermissionState<out P>>.request(): Boolean

Requests a Permission on a Flow of PermissionState

requestAuthorizationStatus

fun AuthorizationStatusHandler.requestAuthorizationStatus(timerHelper: PermissionRefreshScheduler? = null, coroutineScope: <Error class: unknown class>, request: suspend () -> IOSPermissionsHelper.AuthorizationStatus)

Pauses a PermissionRefreshScheduler while requesting an AuthorizationStatus and calls AuthorizationStatusHandler.status once the request has been completed.