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

AndroidPermissionsManager

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

Parameters

context

The context for which to request the Permission

permissions

List of permissions to request. Should correspond to android.Manifest.permission.

coroutineScope

the CoroutineScope to launch permission requests in.

logTag

The tag used for logging

logger

The Logger used for logging

onPermissionChanged

A AndroidPermissionStateHandler that will be notified of changes to AndroidPermissionState

Constructors

AndroidPermissionsManager

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

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

hasPermissions

val hasPermissions: Boolean

true if the permission has been granted.

Functions

requestPermissions

fun requestPermissions()

Starts to request the permissions. Ensure startMonitoring was called to get notified of the permission change. Sets the state to AndroidPermissionState.DENIED_DO_NOT_ASK if the permission cannot be requested.

fun requestPermissions(permissionsToRequest: Array<String>)

Starts to request a specific subset of permissions. Ensure startMonitoring was called to get notified of the permission change. Sets the state to AndroidPermissionState.DENIED_DO_NOT_ASK if the permission cannot be requested. Useful when permissions must be requested in separate phases — e.g. Android requires the background location permission to be requested separately from, and after, foreground location on API 30+.

startMonitoring

fun startMonitoring(interval: Duration)

Starts monitoring for changes to the AndroidPermissionState.

stopMonitoring

fun stopMonitoring()

Stops monitoring for changes to the AndroidPermissionState.