{"id":3645,"url":"https://github.com/permissions-dispatcher/PermissionsDispatcher","last_synced_at":"2025-08-03T22:32:02.800Z","repository":{"id":36481182,"uuid":"40786751","full_name":"permissions-dispatcher/PermissionsDispatcher","owner":"permissions-dispatcher","description":"A declarative API to handle Android runtime permissions.","archived":false,"fork":false,"pushed_at":"2023-11-10T04:44:43.000Z","size":3009,"stargazers_count":11221,"open_issues_count":31,"forks_count":1442,"subscribers_count":264,"default_branch":"master","last_synced_at":"2024-12-03T03:04:18.395Z","etag":null,"topics":["android","java","kotlin","permission","permission-android","permissions","permissions-android"],"latest_commit_sha":null,"homepage":"https://github.com/permissions-dispatcher/PermissionsDispatcher","language":"Java","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/permissions-dispatcher.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2015-08-15T21:41:05.000Z","updated_at":"2024-12-01T13:51:59.000Z","dependencies_parsed_at":"2024-06-19T01:54:48.156Z","dependency_job_id":"9b98cad5-867b-41ec-b6c4-1fd4f0127509","html_url":"https://github.com/permissions-dispatcher/PermissionsDispatcher","commit_stats":{"total_commits":608,"total_committers":41,"mean_commits":"14.829268292682928","dds":0.59375,"last_synced_commit":"74b532bf1fe430fb12ad8414b80399f2d7cfc954"},"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permissions-dispatcher%2FPermissionsDispatcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permissions-dispatcher%2FPermissionsDispatcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permissions-dispatcher%2FPermissionsDispatcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permissions-dispatcher%2FPermissionsDispatcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/permissions-dispatcher","download_url":"https://codeload.github.com/permissions-dispatcher/PermissionsDispatcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228571844,"owners_count":17938772,"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","java","kotlin","permission","permission-android","permissions","permissions-android"],"created_at":"2024-01-05T20:16:47.348Z","updated_at":"2024-12-07T06:30:38.744Z","avatar_url":"https://github.com/permissions-dispatcher.png","language":"Java","funding_links":[],"categories":["Libraries","Java","Android 应用","Tools"],"sub_categories":["Android","Runtime Permissions","网络服务_其他"],"readme":"# PermissionsDispatcher ![CI for pull request](https://github.com/permissions-dispatcher/PermissionsDispatcher/workflows/CI%20for%20pull%20request/badge.svg) [![PermissionsDispatcher](https://www.appbrain.com/stats/libraries/shield/permissions_dispatcher.svg)](https://www.appbrain.com/stats/libraries/details/permissions_dispatcher/permissionsdispatcher)\n\n- **Fully Kotlin/Java support**\n- [**Special permissions support**](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/special_permissions.md)\n- **100% reflection-free**\n\nPermissionsDispatcher provides a simple annotation-based API to handle runtime permissions.\n\nThis library lifts the burden that comes with writing a bunch of check statements whether a permission has been granted or not from you, in order to keep your code clean and safe.\n\n## Usage\n\n- Kotlin: You can pick either of [ktx](https://github.com/permissions-dispatcher/PermissionsDispatcher/tree/master/ktx) or [kapt](https://github.com/permissions-dispatcher/PermissionsDispatcher#0-prepare-androidmanifest).\n- Java: [apt](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/java_usage.md)\n\nHere's a minimum example, in which you register a `MainActivity` which requires `Manifest.permission.CAMERA`.\n\n### 0. Prepare AndroidManifest\n\nAdd the following line to `AndroidManifest.xml`:\n \n`\u003cuses-permission android:name=\"android.permission.CAMERA\" /\u003e`\n\n### 1. Attach annotations\n\nPermissionsDispatcher introduces only a few annotations, keeping its general API concise:\n\n\u003e NOTE: Annotated methods must not be `private`.\n\n|Annotation|Required|Description|\n|---|---|---|\n|`@RuntimePermissions`|**✓**|Register an `Activity` or `Fragment` to handle permissions|\n|`@NeedsPermission`|**✓**|Annotate a method which performs the action that requires one or more permissions|\n|`@OnShowRationale`||Annotate a method which explains why the permissions are needed. It passes in a `PermissionRequest` object which can be used to continue or abort the current permission request upon user input. If you don't specify any argument for the method compiler will generate `process${NeedsPermissionMethodName}ProcessRequest` and `cancel${NeedsPermissionMethodName}ProcessRequest`. You can use those methods in place of `PermissionRequest`(ex: with `DialogFragment`)|\n|`@OnPermissionDenied`||Annotate a method which is invoked if the user doesn't grant the permissions|\n|`@OnNeverAskAgain`||Annotate a method which is invoked if the user chose to have the device \"never ask again\" about a permission|\n\n```kotlin\n@RuntimePermissions\nclass MainActivity : AppCompatActivity(), View.OnClickListener {\n\n    @NeedsPermission(Manifest.permission.CAMERA)\n    fun showCamera() {\n        supportFragmentManager.beginTransaction()\n                .replace(R.id.sample_content_fragment, CameraPreviewFragment.newInstance())\n                .addToBackStack(\"camera\")\n                .commitAllowingStateLoss()\n    }\n\n    @OnShowRationale(Manifest.permission.CAMERA)\n    fun showRationaleForCamera(request: PermissionRequest) {\n        showRationaleDialog(R.string.permission_camera_rationale, request)\n    }\n\n    @OnPermissionDenied(Manifest.permission.CAMERA)\n    fun onCameraDenied() {\n        Toast.makeText(this, R.string.permission_camera_denied, Toast.LENGTH_SHORT).show()\n    }\n\n    @OnNeverAskAgain(Manifest.permission.CAMERA)\n    fun onCameraNeverAskAgain() {\n        Toast.makeText(this, R.string.permission_camera_never_askagain, Toast.LENGTH_SHORT).show()\n    }\n}\n```\n\n### 2. Delegate to generated functions\n\nNow generated functions become much more concise and intuitive than Java version!\n\n```kotlin\n    override fun onCreate(savedInstanceState: Bundle?) {\n        super.onCreate(savedInstanceState)\n        setContentView(R.layout.activity_main)\n        findViewById(R.id.button_camera).setOnClickListener {\n            // NOTE: delegate the permission handling to generated function\n            showCameraWithPermissionCheck()\n        }\n    }\n\n    override fun onRequestPermissionsResult(requestCode: Int, permissions: Array\u003cString\u003e, grantResults: IntArray) {\n        super.onRequestPermissionsResult(requestCode, permissions, grantResults)\n        // NOTE: delegate the permission handling to generated function\n        onRequestPermissionsResult(requestCode, grantResults)\n    }\n```\n\nCheck out the [sample](https://github.com/hotchemi/PermissionsDispatcher/tree/master/sample) for more details.\n\n## Other features/plugins\n\n- [Getting Special Permissions](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/special_permissions.md)\n- [maxSdkVersion](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/maxsdkversion.md)\n- [IntelliJ plugin](https://github.com/shiraji/permissions-dispatcher-plugin)\n- [AndroidAnnotations plugin](https://github.com/AleksanderMielczarek/AndroidAnnotationsPermissionsDispatcherPlugin)\n\n## Installation\n\n**NOTE:**\n  - If you're using jCenter we've moved on to MavenCentral, see [migration guide](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/migration_guide.md).\n  - 4.x only supports [Jetpack](https://developer.android.com/jetpack/). If you still use appcompat 3.x is the way to go.\n\nTo add PermissionsDispatcher to your project, include the following in your **app module** `build.gradle` file:\n\n`${latest.version}` is [![Download](https://maven-badges.herokuapp.com/maven-central/com.github.permissions-dispatcher/permissionsdispatcher/badge.svg)](https://search.maven.org/search?q=g:com.github.permissions-dispatcher)\n\n```groovy\ndependencies {\n  implementation \"com.github.permissions-dispatcher:permissionsdispatcher:${latest.version}\"\n  annotationProcessor \"com.github.permissions-dispatcher:permissionsdispatcher-processor:${latest.version}\"\n}\n```\n\nWith Kotlin:\n\n```groovy\napply plugin: 'kotlin-kapt'\n\ndependencies {\n  implementation \"com.github.permissions-dispatcher:permissionsdispatcher:${latest.version}\"\n  kapt \"com.github.permissions-dispatcher:permissionsdispatcher-processor:${latest.version}\"\n}\n```\n\n## License\n\n```\nCopyright 2016 Shintaro Katafuchi, Marcel Schnelle, Yoshinori Isogai\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermissions-dispatcher%2FPermissionsDispatcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpermissions-dispatcher%2FPermissionsDispatcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermissions-dispatcher%2FPermissionsDispatcher/lists"}