Adds support to request Siri permission on iOS. (Baseflow#1265)

* Adding SiriKit permissions (Baseflow#1140) * Adding SiriKit permissions * Fix tests --------- Co-authored-by: Maurits van Beusekom <[email protected]> * Reserves the assistant permission on no-op platforms * Adds support to example application * Remove pubspec overrides * Fix formatting * Add support for Permission.assistant to the app facing package. * Fix formatting --------- Co-authored-by: Baptiste DUPUCH <[email protected]>
vishalknishad · Jan 17, 2024 · 78a549c · 78a549c
1 parent e0b76c2
commit 78a549c
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 12 deletions.
diff --git a/permission_handler/CHANGELOG.md b/permission_handler/CHANGELOG.md
@@ -1,4 +1,9 @@
+## 11.2.0
+
+* Adds the `Permission.assistant` which allows users to request permissions to access SiriKit on iOS and macOS platforms. This is a no-op on all other platforms.
+
 ## 11.1.0
+
 * Adds support for iOS 17+ [Calendar access levels](https://developer.apple.com/documentation/technotes/tn3152-migrating-to-the-latest-calendar-access-levels).
 * Deprecates `Permission.calendar`. Use `Permission.calendarWriteOnly` to request a write-only access to the calendar. For full access to calendar use `Permission.calendarFullAccess`.
 * For `Permission.calendarFullAccess` on iOS 17+ use `PERMISSION_EVENTS_FULL_ACCESS` in Podfile instead of  `PERMISSION_EVENTS`.

diff --git a/permission_handler/README.md b/permission_handler/README.md
@@ -283,6 +283,25 @@ If your application needs access to Android's file system, it is possible to req
 
 Starting with Android 10, apps are required to first obtain permission to read the device's location in the foreground, before requesting to read the location in the background as well. When requesting the 'location always' permission directly, or when requesting both permissions at the same time, the system will ignore the request. So, instead of calling only `Permission.location.request()`, make sure to first call either `Permission.location.request()` or `Permission.locationWhenInUse.request()`, and obtain permission to read the GPS. Once you obtain this permission, you can call `Permission.locationAlways.request()`. This will present the user with the option to update the settings so the location can always be read in the background. For more information, visit the [Android documentation on requesting location permissions](https://developer.android.com/training/location/permissions#request-only-foreground).
 
+### Checking or requesting a permission terminates the application on iOS. What can I do?
+
+First of all make sure all that the `ios/Runner/Info.plist` file contains entries for all the permissions the application requires. If an entry is missing iOS will terminate the application as soon as the particular permission is being checked or requested.
+
+If the application requires access to SiriKit (by requesting the `Permission.assistant` permission), also make sure to add the `com.apple.developer.siri` entitlement to the application configuration. To do so create a file (if it doesn't exists already) called `Runner.entitlements` in the `ios/Runner` folder that is part of the project. Open the file and add the following contents:
+
+```xml
+<?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>
+	<key>com.apple.developer.siri</key>
+	<true/>
+</dict>
+</plist>
+```
+
+The important part here is the `key` with value `com.apple.developer.siri` and the element `<true/>`. It is possible that this file also contains other entitlements depending on the needs of the application.
+
 ## Issues
 
 Please file any issues, bugs, or feature requests as an issue on our [GitHub](https://github.com/Baseflow/flutter-permission-handler/issues) page. Commercial support is available if you need help with integration with your app or services. You can contact us at [[email protected]](mailto:[email protected]).

diff --git a/permission_handler/example/ios/Podfile b/permission_handler/example/ios/Podfile
@@ -71,7 +71,7 @@ post_install do |installer|
 
         ## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse]
         'PERMISSION_LOCATION=1',
-       
+
         ## dart: PermissionGroup.notification
         'PERMISSION_NOTIFICATIONS=1',
 
@@ -89,6 +89,9 @@ post_install do |installer|
 
         ## dart: PermissionGroup.criticalAlerts
         'PERMISSION_CRITICAL_ALERTS=1',
+
+        ## dart: PermissionGroup.assistant
+        'PERMISSION_ASSISTANT=1',
       ]
 
     end

diff --git a/permission_handler/example/ios/Runner.xcodeproj/project.pbxproj b/permission_handler/example/ios/Runner.xcodeproj/project.pbxproj
@@ -47,6 +47,7 @@
 		C446183715B92022DDB68882 /* Pods_Runner.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Runner.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		CEA40B36DE135D81D16B7399 /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
 		DA7CB50DE8057A7A8D126AC9 /* Pods-Runner.profile.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.profile.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.profile.xcconfig"; sourceTree = "<group>"; };
+		F6BD02752B56D87600C59EAA /* RunnerDebug.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = RunnerDebug.entitlements; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -112,6 +113,7 @@
 		97C146F01CF9000F007C117D /* Runner */ = {
 			isa = PBXGroup;
 			children = (
+				F6BD02752B56D87600C59EAA /* RunnerDebug.entitlements */,
 				97C146FA1CF9000F007C117D /* Main.storyboard */,
 				97C146FD1CF9000F007C117D /* Assets.xcassets */,
 				97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */,
@@ -494,6 +496,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CLANG_ENABLE_MODULES = YES;
+				CODE_SIGN_ENTITLEMENTS = Runner/RunnerDebug.entitlements;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
 				DEVELOPMENT_TEAM = 7624MWN53C;
 				ENABLE_BITCODE = NO;

diff --git a/permission_handler/example/ios/Runner/Info.plist b/permission_handler/example/ios/Runner/Info.plist
@@ -101,9 +101,14 @@
     <!-- Permission options for the `appTrackingTransparency` -->
     <key>NSUserTrackingUsageDescription</key>
     <string>appTrackingTransparency</string>
-	<key>CADisableMinimumFrameDurationOnPhone</key>
-	<true/>
-	<key>UIApplicationSupportsIndirectInputEvents</key>
-	<true/>
+
+    <!-- Permission options for the `assistant` group -->
+    <key>NSSiriUsageDescription</key>
+    <string>The example app would like access to Siri Kit to demonstrate requesting authorization.</string>
+
+    <key>CADisableMinimumFrameDurationOnPhone</key>
+    <true/>
+    <key>UIApplicationSupportsIndirectInputEvents</key>
+    <true/>
 </dict>
 </plist>
diff --git a/permission_handler/example/ios/Runner/RunnerDebug.entitlements b/permission_handler/example/ios/Runner/RunnerDebug.entitlements
@@ -0,0 +1,8 @@
+<?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>
+	<key>com.apple.developer.siri</key>
+	<true/>
+</dict>
+</plist>
diff --git a/permission_handler/example/lib/main.dart b/permission_handler/example/lib/main.dart
@@ -63,7 +63,8 @@ class _PermissionHandlerWidgetState extends State<PermissionHandlerWidget> {
                       permission != Permission.reminders &&
                       permission != Permission.bluetooth &&
                       permission != Permission.appTrackingTransparency &&
-                      permission != Permission.criticalAlerts;
+                      permission != Permission.criticalAlerts &&
+                      permission != Permission.assistant;
                 }
               })
               .map((permission) => PermissionWidget(permission))

diff --git a/permission_handler/pubspec.yaml b/permission_handler/pubspec.yaml
@@ -2,7 +2,7 @@ name: permission_handler
 description: Permission plugin for Flutter. This plugin provides a cross-platform (iOS, Android) API to request and check permissions.
 repository: https://github.com/baseflow/flutter-permission-handler
 issue_tracker: https://github.com/Baseflow/flutter-permission-handler/issues
-version: 11.1.0
+version: 11.2.0
 
 environment:
   sdk: ">=2.15.0 <4.0.0"
@@ -24,11 +24,11 @@ dependencies:
   flutter:
     sdk: flutter
   meta: ^1.7.0
-  permission_handler_android: ^12.0.1
-  permission_handler_apple: ^9.2.0
-  permission_handler_html: ^0.1.0+1
-  permission_handler_windows: ^0.2.0
-  permission_handler_platform_interface: ^4.0.2
+  permission_handler_android: ^12.0.3
+  permission_handler_apple: ^9.3.0
+  permission_handler_html: ^0.1.1
+  permission_handler_windows: ^0.2.1
+  permission_handler_platform_interface: ^4.1.0
 
 dev_dependencies:
   flutter_lints: ^1.0.4