flutter_easy_permission

Description:

flutter easy permission

flutter_easy_permission #
中文文档 | English
Permission plugin for Flutter.This is a wrapper for the easypermissions library.

Android
iOS

Usage #

Configure permissions
Permissions should be checked first when calling certain APIs
No permission, then request from the user
Handling callbacks

Configure permissions #
Android
Open the android/app/src/main/AndroidManifest.xml file in the project root directory and configure the permissions you need:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="xyz.bczl.flutter.easy_permission_example">
<!-- Configure permissions here -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.CAMERA"/>
<application
android:label="flutter_easy_permission_example"
android:icon="@mipmap/ic_launcher">
<!-- ............. -->
</application>
</manifest>
copied to clipboard
For a detailed description of these constants, go here.
To understand how permissions are handled on Android, here's a comprehensive document.
iOS
Open the ios/Runner/Info.plist file in the project root directory and configure the permissions you need:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- Configure permissions here -->
<key>NSCameraUsageDescription</key>
<string>Explain to the user here why you need the permission</string>

<!-- ............. -->
</dict>
</plist>
copied to clipboard
Note that replacing the content of the <string></string> tag gives the user a reason for needing the permission.
For a detailed explanation of iOS permissions, you can go here.
Integrating permissions that are not required in iOS may not pass the app shop, so do not integrate those that are not used, you will also need to do some configuration.
Open the ios/Podfile file and add the following code:
target 'Runner' do
flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
# Add the library of permissions you need here
pod 'EasyPermissionX/Camera'
end
copied to clipboard
You can integrate the following libraries:
pod 'EasyPermissionX/Camera'
pod 'EasyPermissionX/Photo'
pod 'EasyPermissionX/Contact'
pod 'EasyPermissionX/Location'
pod 'EasyPermissionX/Reminder'
pod 'EasyPermissionX/Calendar'
pod 'EasyPermissionX/Microphone'
pod 'EasyPermissionX/Health'
pod 'EasyPermissionX/Net'
pod 'EasyPermissionX/Tracking'
pod 'EasyPermissionX/Media'
pod 'EasyPermissionX/Notification'
pod 'EasyPermissionX/Bluetooth'
copied to clipboard
Once configured, you need to run the command install in the project's ios directory:
pod install
copied to clipboard
Check Permissions #
const permissions = [Permissions.CAMERA];
const permissionGroup = [PermissionGroup.Camera];

bool ret = await FlutterEasyPermission.has(perms: permissions,permsGroup: permissionGroup);
copied to clipboard
Since Android and iOS permissions are very different, it is difficult to handle them uniformly, so you have to handle them separately. The parameter perms corresponds to Android permissions and the parameter permsGroup to iOS permissions. The app can only run on one platform at a time, so you don't need to worry about messing up.
Note the relationship between the API and the library, to check and request the relevant permissions you must integrate the corresponding library, see the following table:



PermissionGroup
Info.plist
Integrated lib




Calendar
NSCalendarsUsageDescription
EasyPermissionX/Calendar


Reminders
NSRemindersUsageDescription
EasyPermissionX/Reminder


Contacts
NSContactsUsageDescription
EasyPermissionX/Contact


Camera
NSCameraUsageDescription
EasyPermissionX/Camera


Microphone
NSMicrophoneUsageDescription
EasyPermissionX/Microphone


Photos
NSPhotoLibraryUsageDescription
EasyPermissionX/Photo


Location
NSLocationUsageDescription NSLocationAlwaysAndWhenInUseUsageDescription NSLocationWhenInUseUsageDescription
EasyPermissionX/Location


Notification
PermissionGroupNotification
EasyPermissionX/Notification


Bluetooth
NSBluetoothAlwaysUsageDescription NSBluetoothPeripheralUsageDescription
EasyPermissionX/Bluetooth



Request permission #
FlutterEasyPermission.request(
perms: permissions,permsGroup: permissionGroup,rationale:"Test permission requests here");
copied to clipboard
Handling callbacks #
void initState() {
super.initState();
_easyPermission = FlutterEasyPermission()
..addPermissionCallback(
onGranted: (requestCode,perms,perm){
debugPrint("Android Authorized:$perms");
debugPrint("iOS Authorized:$perm");
},
onDenied: (requestCode,perms,perm,isPermanent){
if(isPermanent){
FlutterEasyPermission.showAppSettingsDialog(title: "Camera");
}else{
debugPrint("Android Deny authorization:$perms");
debugPrint("iOS Deny authorization:$perm");
}
},);
}

void dispose() {
_easyPermission.dispose();
super.dispose();
}
copied to clipboard
When isPermanent returns true, it indicates that the system will not pop up an authorization dialog when requesting permissions, so you may need to pop up a dialog yourself with content that mainly prompts the user, and if you must use this feature, you can go to the system settings page to reopen the permissions.
On Android, you may also need to implement the onSettingsReturned callback function to better handle permission interactions.It is the callback after showAppSettingsDialog is called
Example #
For a complete example, please see here.