Package-level declarations

Types

Link copied to clipboard

Functions

Link copied to clipboard

Checks if the app has the background location permission.

Link copied to clipboard

Checks if the application has permission to use Bluetooth.

Link copied to clipboard

Checks if the application has permission to access the camera.

Link copied to clipboard

Checks if the application has permission to install APK files.

Link copied to clipboard
fun hasLocationPermission(preciseLocation: Boolean = true): Boolean

Checks if the app has the required location permissions.

Link copied to clipboard

Checks if the application has permission to post notifications.

Checks if the app has notification permission.

Checks if the application has permission to display notifications.

Checks if the app has permission to display notifications on iOS.

Checks if the application has permission to display notifications.

Link copied to clipboard

Checks if the application has permission to draw overlays on top of other apps.

Link copied to clipboard

Determines whether the app has been granted permission to read contacts.

Link copied to clipboard
fun hasReadExternalStoragePermission(mediaTypes: Set<MediaType> = emptySet()): Boolean

Checks if the application has permission to read external storage or specific media types.

Link copied to clipboard

Checks if the application has permission to record audio.

Link copied to clipboard

Checks if the application has permission to write to contacts (WRITE_CONTACTS).

Link copied to clipboard
fun requestBackgroundLocationPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests the background location permission. Before requesting ACCESS_BACKGROUND_LOCATION, ensure ACCESS_FINE_LOCATION is already granted, use hasLocationPermission and requestLocationPermission()

Link copied to clipboard
fun requestBluetoothPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests Bluetooth permission for the application.

Link copied to clipboard
fun requestCameraPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests camera permission for the application.

Link copied to clipboard
actual fun requestInstallPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests the install permission required to allow the app to install APK files from unknown sources. This method checks if the required permission has already been granted. If granted, the onGranted callback is invoked. If not, the method triggers a permission request workflow via a dedicated PermissionActivity, and the appropriate callback (onGranted or onDenied) is invoked based on the user's action.

actual fun requestInstallPermission(onGranted: () -> Unit, onDenied: () -> Unit)
expect fun requestInstallPermission(onGranted: () -> Unit, onDenied: () -> Unit)
actual fun requestInstallPermission(onGranted: () -> Unit, onDenied: () -> Unit)
actual fun requestInstallPermission(onGranted: () -> Unit, onDenied: () -> Unit)
actual fun requestInstallPermission(onGranted: () -> Unit, onDenied: () -> Unit)
Link copied to clipboard
fun requestLocationPermission(preciseLocation: Boolean = true, onGranted: () -> Unit, onDenied: () -> Unit)

Requests location permissions.

Link copied to clipboard
actual fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests notification permission for the application. On Android 13 (API 33) and above, this method initiates an intent to the system settings screen where the user can grant the notification permission.

expect fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests notification permission on the platform.

actual fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests permission to display notifications.

fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit, onDefault: () -> Unit)

Extended version of the permission request handling the "default" case.

actual fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit)
actual fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests notification permission from the user on iOS.

actual fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests permission to display notifications.

fun requestNotificationPermission(onGranted: () -> Unit, onDenied: () -> Unit, onDefault: () -> Unit)

Extended version of the permission request handling the "default" case.

Link copied to clipboard
fun requestOverlayPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests overlay permission for the application. On Android M (API 23) and above, this method initiates an intent to the system settings screen where the user can grant the overlay permission.

Link copied to clipboard
fun requestReadContactsPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests the READ_CONTACTS permission from the user. If the permission is already granted, the onGranted callback is invoked. Otherwise, a request for the permission is initiated. Note: Ensure to add the following permission in the app's manifest file:

Link copied to clipboard
fun requestReadExternalStoragePermission(mediaTypes: Set<MediaType> = emptySet(), onGranted: () -> Unit, onDenied: () -> Unit)

Requests read external storage permission for the application.

Link copied to clipboard
fun requestRecordAudioPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests record audio permission for the application.

Link copied to clipboard
fun requestWriteContactsPermission(onGranted: () -> Unit, onDenied: () -> Unit)

Requests permission to write to contacts (WRITE_CONTACTS).