permission_request_page 1.0.0

permission_request_page: ^1.0.0 copied to clipboard

Is it annoying to create a page that explains permissions to users or implement permission request functionality? If so, try this plugin! This plugin simplifies the implementation of the above features. If you don't like the default template, you can customize it using the builder defined in PermissionRequestPage.

Getting started #

To use this plugin, add permission_request_page as a dependency in your pubspec.yaml file. For example:

dependencies:
  permission_request_page: ^1.0.0

How to use #

Declare the required permissions in your app.

const List<PermissionData> _kPermission = [
  PermissionData(
    permissionType: PermissionType.location,
    description: 'Required to provide location services.',
    isNecessary: true,
  ),
  PermissionData(
    permissionType: PermissionType.storage,
    description: 'Required to access the internal storage of the smartphone.',
    isNecessary: false,
  ),
  PermissionData(
    permissionType: PermissionType.notification,
    description: 'Required to provide notifications.',
    isNecessary: false,
  ),
];

Write an init function to execute when all required permissions are granted.

class _SplashPageState extends State<SplashPage> {
  Future<InitResult> _initFunction() async {
    InitResult initResult;
    try {
      // Write your app initialization code.
      initResult = const InitResult(complete: true);
    } catch (error, stackTrace) {
      // Write code to handle app initialization errors.
      initResult =
          InitResult(complete: false, error: error, stackTrace: stackTrace);
    }

    // If the complete value of InitResult is true, it navigates to the nextPage.
    return initResult;
  }

  @override
  Widget build(BuildContext context) {
    // ...
  }
}

Add a PermissionRequestPage widget under Scaffold.

class _SplashPageState extends State<SplashPage> {
  Future<InitResult> _initFunction() async {
    // ...
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: PermissionRequestPage(
        permissions: _kPermission,
        initFunction: _initFunction,
        nextPage: Container(),
      ),
    );
  }
}

Declare the permissions to use for each platform.

🐤 Android #

/android/app/src/main/AndroidManifest.xml

<!-- PermissionType.calendar -->
<uses-permission android:name="android.permission.READ_CALENDAR" />
<uses-permission android:name="android.permission.WRITE_CALENDAR" />

<!-- PermissionType.camera -->
<uses-permission android:name="android.permission.CAMERA" />

<!-- PermissionType.contacts -->
<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.WRITE_CONTACTS" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />

<!-- PermissionType.storage -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<!-- PermissionType.sms -->
<uses-permission android:name="android.permission.SEND_SMS" />
<uses-permission android:name="android.permission.RECEIVE_SMS" />
<uses-permission android:name="android.permission.READ_SMS" />
<uses-permission android:name="android.permission.RECEIVE_WAP_PUSH" />
<uses-permission android:name="android.permission.RECEIVE_MMS" />

<!-- PermissionType.phone -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.CALL_PHONE" />
<uses-permission android:name="android.permission.ADD_VOICEMAIL" />
<uses-permission android:name="android.permission.USE_SIP" />
<uses-permission android:name="android.permission.READ_CALL_LOG" />
<uses-permission android:name="android.permission.WRITE_CALL_LOG" />
<uses-permission android:name="android.permission.BIND_CALL_REDIRECTION_SERVICE" />

<!-- PermissionType.location, PermissionType.locationAlways -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

<!-- PermissionType.microphone, PermissionType.speech -->
<uses-permission android:name="android.permission.RECORD_AUDIO" />

<!-- PermissionType.accessMediaLocation -->
<uses-permission android:name="android.permission.ACCESS_MEDIA_LOCATION" />

<!-- PermissionType.sensors -->
<uses-permission android:name="android.permission.BODY_SENSORS" />

<!-- PermissionType.activityRecognition -->
<uses-permission android:name="android.permission.ACTIVITY_RECOGNITION" />

<!-- PermissionType.bluetooth -->
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />

<!-- PermissionType.systemAlertWindow -->
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />

🐤 iOS #

/ios/Runner/info.plist

<!-- PermissionType.calendar -->
<key>NSCalendarsUsageDescription</key>
<string>description</string>

<!-- PermissionType.camera -->
<key>NSCameraUsageDescription</key>
<string>description</string>

<!-- PermissionType.contacts -->
<key>NSContactsUsageDescription</key>
<string>description</string>

<!-- PermissionType.location, PermissionType.locationAlways -->
<key>NSLocationWhenInUseUsageDescription</key>
<string>description</string>
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>description</string>
<key>NSLocationUsageDescription</key>
<string>description</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>description</string>

<!-- PermissionType.microphone -->
<key>NSMicrophoneUsageDescription</key>
<string>description</string>

<!-- PermissionType.photos -->
<key>NSPhotoLibraryUsageDescription</key>
<string>description</string>

<!-- PermissionType.mediaLibrary -->
<key>NSAppleMusicUsageDescription</key>
<string>description</string>
<key>kTCCServiceMediaLibrary</key>
<string>description</string>

<!-- PermissionType.sensors -->
<key>NSMotionUsageDescription</key>
<string>description</string>

<!-- PermissionType.speech -->
<key>NSSpeechRecognitionUsageDescription</key>
<string>description</string>

<!-- PermissionType.reminders -->
<key>NSRemindersUsageDescription</key>
<string>description</string>

/ios/Podfile

post_install do |installer|
  installer.pods_project.targets.each do |target|
  
    # Add
    target.build_configurations.each do |config|
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',
        
        # See the table below to add macros for permissions to use in your app.
        'PERMISSION_LOCATION=1',
        'PERMISSION_NOTIFICATIONS=1'
      ]
    end

    flutter_additional_ios_build_settings(target)
  end
end

Support #

If you find any bugs or issues while using the plugin, please register an issues on GitHub. You can also contact us at [email protected].