Courtesy: GitHub

Android RuntimePermissions Sample

This sample shows runtime permissions available in Android M and above. It shows how to check and request permissions at runtime, handle backwards compatibility using the support library and how to declare optional permissions for M-devices only.

Introduction

Android M introduced runtime permissions. Applications targeting M and above need to request their permissions at runtime. All permissions still need to be declared in the AndroidManifest. However, when accessing APIs that require a permission, the Activity or Fragment has to verify that the permission has been granted or request the missing permissions using calls through the support library. Permissions are checked through ActivityCompat#checkSelfPermission(Context, String) or ContextCompat#checkSelfPermission(Context, String). Permission are requested through ActivityCompat#requestPermissions(Activity, String[], int), and the response received in a callback to ActivityCompat.OnRequestPermissionsResultCallback#onRequestPermissionsResult(int, String[], int[]). Applications can provide an additional rational for the use of permissions after calling ActivityCompat#shouldShowRequestPermissionRationale(Activity,String). This call will return true if the application should provide the user with more context on why the requested permissions is needed, for example if the permission request has been denied before.

If an application targets an SDK below M, all permissions are granted at runtime and are available when the application is running. The support library calls handle these checks appropriately. However, if permissions have been turned off in the system settings for an application targeting an SDK below M, the API will return empty or no data.

Pre-requisites

  • Android SDK 26
  • Android Build Tools v26.0.1
  • Android Support Repository

Screenshots

Screenshot Screenshot

Getting Started

This sample uses the Gradle build system. To build this project, use the "gradlew build" command or use "Import Project" in Android Studio.

Support

If you've found an error in this sample, please file an issue: https://github.com/googlesamples/android-RuntimePermissions

Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.

License

Copyright 2017 The Android Open Source Project, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

compileSdkVersion 26

applicationId "com.example.android.system.runtimepermissions"

minSdkVersion 15

targetSdkVersion 26

versionCode 1

versionName "1.0"

compile fileTree(dir: 'libs', include: ['*.jar'])

compile "com.android.support:support-v13:26.0.0"

compile "com.android.support:appcompat-v7:26.0.0"

compile 'com.android.support:design:26.0.0'

testCompile 'junit:junit:4.12'

compile "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"

package com.example.android.system.runtimepermissions

uses-permission

  • android.permission.CAMERA

package com.example.android.system.runtimepermissions

uses-permission

  • android.permission.CAMERA

MainActivity

MainActivity

Launcher Activity that demonstrates the use of runtime permissions for Android M. It contains a summary sample description, sample log and a Fragment that calls callbacks on this Activity to illustrate parts of the runtime permissions API.

This Activity requests permissions to access the camera ({@link android.Manifest.permission#CAMERA}) when the 'Show Camera' button is clicked to display the camera preview. Contacts permissions (({@link android.Manifest.permission#READ_CONTACTS} and ({@link android.Manifest.permission#WRITE_CONTACTS})) are requested when the 'Show and Add Contacts' button is clicked to display the first contact in the contacts database and to add a dummy contact directly to it. Permissions are verified and requested through compat helpers in the support v4 library, in this Activity using {@link ActivityCompat}. First, permissions are checked if they have already been granted through {@link ActivityCompat#checkSelfPermission(Context, String)}. If permissions have not been granted, they are requested through {@link ActivityCompat#requestPermissions(Activity, String[], int)} and the return value checked in a callback to the {@link android.support.v4.app.ActivityCompat.OnRequestPermissionsResultCallback} interface.

Before requesting permissions, {@link ActivityCompat#shouldShowRequestPermissionRationale(Activity, String)} should be called to provide the user with additional context for the use of permissions if they have been denied previously.

If this sample is executed on a device running a platform version below M, all permissions declared in the Android manifest file are always granted at install time and cannot be requested at run time.

This sample targets the M platform and must therefore request permissions at runtime. Change the targetSdk in the file 'Application/build.gradle' to 22 to run the application in compatibility mode. Now, if a permission has been disable by the system through the application settings, disabled APIs provide compatibility data. For example the camera cannot be opened or an empty list of contacts is returned. No special action is required in this case.

(This class is based on the MainActivity used in the SimpleFragment sample template.)

Id to identify a camera permission request.

Id to identify a contacts permission request.

Permissions required to read and write contacts. Used by the {@link ContactsFragment}.

Root of the layout of this Activity.

Called when the 'show camera' button is clicked. Callback is defined in resource layout definition.

Requests the Camera permission. If the permission has been denied previously, a SnackBar will prompt the user to grant the permission, otherwise it is requested directly.

Called when the 'show camera' button is clicked. Callback is defined in resource layout definition.

Requests the Contacts permissions. If the permission has been denied previously, a SnackBar will prompt the user to grant the permission, otherwise it is requested directly.

Display the {@link CameraPreviewFragment} in the content area if the required Camera permission has been granted.

Display the {@link ContactsFragment} in the content area if the required contacts permissions have been granted.

Callback received when a permissions request has been completed.