{"id":13658293,"url":"https://github.com/icerockdev/moko-permissions","last_synced_at":"2025-04-04T06:08:13.404Z","repository":{"id":41070807,"uuid":"204852840","full_name":"icerockdev/moko-permissions","owner":"icerockdev","description":"Runtime permissions controls for mobile (android \u0026 ios) Kotlin Multiplatform development","archived":false,"fork":false,"pushed_at":"2024-08-16T00:49:02.000Z","size":353,"stargazers_count":363,"open_issues_count":25,"forks_count":36,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-09-24T05:02:23.349Z","etag":null,"topics":["android","coroutines","ios","kotlin-multiplatform","kotlin-multiplatform-mobile","kotlin-native","moko"],"latest_commit_sha":null,"homepage":"https://moko.icerock.dev/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/icerockdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-28T05:10:53.000Z","updated_at":"2024-09-22T19:19:43.000Z","dependencies_parsed_at":"2023-12-07T13:26:03.875Z","dependency_job_id":"653a9e6f-3c26-4ee0-9d3b-8822642f4ec2","html_url":"https://github.com/icerockdev/moko-permissions","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icerockdev%2Fmoko-permissions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icerockdev%2Fmoko-permissions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icerockdev%2Fmoko-permissions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/icerockdev%2Fmoko-permissions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/icerockdev","download_url":"https://codeload.github.com/icerockdev/moko-permissions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247128741,"owners_count":20888234,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","coroutines","ios","kotlin-multiplatform","kotlin-multiplatform-mobile","kotlin-native","moko"],"created_at":"2024-08-02T05:00:58.393Z","updated_at":"2025-04-04T06:08:13.385Z","avatar_url":"https://github.com/icerockdev.png","language":"Kotlin","funding_links":[],"categories":["Multiplatform","Libraries"],"sub_categories":["Multiplatform libraries","📱 Device"],"readme":"![moko-permissions](img/logo.png)  \n[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](https://img.shields.io/maven-central/v/dev.icerock.moko/permissions) ](https://repo1.maven.org/maven2/dev/icerock/moko/permissions) ![kotlin-version](https://kotlin-version.aws.icerock.dev/kotlin-version?group=dev.icerock.moko\u0026name=permissions)\n\n# Mobile Kotlin runtime permissions multiplatform controller\n**moko-permissions** - Kotlin MultiPlatform library for providing runtime permissions on iOS \u0026 Android.\n\n## Table of Contents\n- [Features](#features)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [List of supported permissions](#list-of-supported-permissions)\n- [Usage](#usage)\n- [Samples](#samples)\n- [Set Up Locally](#set-up-locally)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n- **Permission** - enumeration with primary types of device permissions\n- **PermissionsController** - handler for runtime permission requests can be used in the common code with lifecycle safety for Android\n- **DeniedException** and **DeniedAlwaysException** - exceptions to handle user denial of permissions\n- **Compose Multiplatform** support\n\n## Requirements\n- Gradle version 6.8+\n- Android API 16+\n- iOS version 12.0+\n\n## Installation\nroot **build.gradle**\n```groovy\nallprojects {\n    repositories {\n      mavenCentral()\n    }\n}\n```\n\nproject **build.gradle**\n```groovy\ndependencies {\n    commonMainApi(\"dev.icerock.moko:permissions:0.19.1\")\n  \n    // specific permissions support\n    commonMainImplementation(\"dev.icerock.moko:permissions-bluetooth:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-camera:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-contacts:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-gallery:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-location:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-microphone:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-motion:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-notifications:0.19.1\")\n    commonMainImplementation(\"dev.icerock.moko:permissions-storage:0.19.1\")\n    \n    // compose multiplatform\n    commonMainApi(\"dev.icerock.moko:permissions-compose:0.19.1\") // permissions api + compose extensions\n    \n    commonTestImplementation(\"dev.icerock.moko:permissions-test:0.19.1\")\n}\n```\n\n## List of supported permissions\n\n* `dev.icerock.moko:permissions-bluetooth`\n  * Bluetooth LE: **Permission.BLUETOOTH_LE**\n  * Bluetooth Scan: **Permission.BLUETOOTH_SCAN**\n  * Bluetooth Connect: **Permission.BLUETOOTH_CONNECT**\n  * Bluetooth Advertise: **Permission.BLUETOOTH_ADVERTISE**\n* `dev.icerock.moko:permissions-camera`\n  * Camera: **Permission.CAMERA**\n* `dev.icerock.moko:permissions-contacts`\n  * Contacts: **Permission.CONTACTS**\n* `dev.icerock.moko:permissions-gallery`\n  * Gallery: **Permission.GALLERY** \n* `dev.icerock.moko:permissions-location`\n  * Fine location: **Permission.LOCATION**\n  * Coarse location: **Permission.COARSE_LOCATION**\n  * Background location: **Permission.BACKGROUND_LOCATION**\n* `dev.icerock.moko:permissions-microphone`\n  * Audio recording: **Permission.RECORD_AUDIO**\n* `dev.icerock.moko:permissions-motion`\n  * Motion: **Permission.MOTION**\n* `dev.icerock.moko:permissions-notifications`\n  * Remote notifications: **Permission.REMOTE_NOTIFICATION**\n* `dev.icerock.moko:permissions-storage`\n  * Storage read: **Permission.STORAGE**\n  * Storage write: **Permission.WRITE_STORAGE**\n\n## Usage\n\nCommon code:\n```kotlin\nclass ViewModel(val permissionsController: PermissionsController): ViewModel() {\n    fun onPhotoPressed() {\n        viewModelScope.launch {\n            try {\n                permissionsController.providePermission(Permission.GALLERY)\n                // Permission has been granted successfully.\n            } catch(deniedAlways: DeniedAlwaysException) {\n                // Permission is always denied.\n            } catch(denied: DeniedException) {\n                // Permission was denied.\n            }\n        }\n    }\n}\n```\n\nAndroid:\n```kotlin\noverride fun onCreate(savedInstanceState: Bundle?) {\n    super.onCreate(savedInstanceState)\n        \n    val viewModel = getViewModel {\n        // Pass the platform implementation of the permission controller to a common code.\n        ViewModel(PermissionsController())\n    }\n    \n    // Binds the permissions controller to the activity lifecycle.\n    viewModel.permissionsController.bind(activity)\n}\n```\n\nCompose:\n```kotlin\n@Composable\nfun TestScreen() {\n    val viewModel = getViewModel {\n        // Pass the platform implementation of the permission controller to a common code.\n        ViewModel(PermissionsController())\n    }\n    \n    // Binds the permissions controller to the LocalLifecycleOwner lifecycle.\n    BindEffect(viewModel.permissionsController)\n}\n```\n\niOS:\n```swift\n// Just pass the platform implementation of the permission controller to a common code.\nlet viewModel = ViewModel(permissionsController: PermissionsController())\n```\n\n### Compose Multiplatform\n```kotlin\n@Composable\nfun Sample() {\n    val factory: PermissionsControllerFactory = rememberPermissionsControllerFactory()\n    val controller: PermissionsController = remember(factory) { factory.createPermissionsController() }\n    val coroutineScope: CoroutineScope = rememberCoroutineScope()\n    \n    Button(\n        onClick = {\n            coroutineScope.launch {\n                controller.providePermission(Permission.REMOTE_NOTIFICATION)\n            }\n        }\n    ) {\n        Text(text = \"give permissions\")\n    }\n}\n```\n\nOr with `moko-mvvm` with correct configuration change handle on android:\n```kotlin\n@Composable\nfun Sample() {\n    val factory: PermissionsControllerFactory = rememberPermissionsControllerFactory()\n    val viewModel: PermissionsViewModel = getViewModel(\n        key = \"permissions-screen\",\n        factory = viewModelFactory { PermissionsViewModel(factory.createPermissionsController()) }\n    )\n    \n    BindEffect(viewModel.permissionsController)\n\n    Button(onClick = viewModel::onButtonClick) {\n        Text(text = \"give permissions\")\n    }\n}\n\nclass PermissionsViewModel(\n    val permissionsController: PermissionsController\n) : ViewModel() {\n    fun onButtonClick() {\n        viewModelScope.launch {\n            permissionsController.providePermission(Permission.REMOTE_NOTIFICATION)\n        }\n    }\n}\n```\n\n## Samples\nMore examples can be found in the [sample directory](sample).\n\n## Set Up Locally \n- In [permissions directory](permissions) contains `permissions` library;\n- In [sample directory](sample) contains samples on android, ios \u0026 mpp-library connected to apps.\n\n## Contributing\nAll development (both new features and bug fixes) is performed in `develop` branch. This way `master` sources always contain sources of the most recently released version. Please send PRs with bug fixes to `develop` branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in `master`.\n\nThe `develop` branch is pushed to `master` during release.\n\nMore detailed guide for contributers see in [contributing guide](CONTRIBUTING.md).\n\n## License\n        \n    Copyright 2019 IceRock MAG Inc\n    \n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n    \n       http://www.apache.org/licenses/LICENSE-2.0\n    \n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficerockdev%2Fmoko-permissions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficerockdev%2Fmoko-permissions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficerockdev%2Fmoko-permissions/lists"}