[quick_actions] add localizedSubtitle for iOS

packages/quick_actions/quick_actions/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.9
+
+* Adds localizedSubtitle field for iOS quick actions.
+
 ## 1.0.8
 
 * Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.

packages/quick_actions/quick_actions/README.md

@@ -34,7 +34,7 @@ Finally, manage the app's quick actions, for instance:
 ```dart
 quickActions.setShortcutItems(<ShortcutItem>[
   const ShortcutItem(type: 'action_main', localizedTitle: 'Main view', icon: 'icon_main'),
-  const ShortcutItem(type: 'action_help', localizedTitle: 'Help', icon: 'icon_help')
+  const ShortcutItem(type: 'action_help', localizedTitle: 'Help', localizedSubtitle: 'Tap to get help', icon: 'icon_help')
 ]);
 ```
 

packages/quick_actions/quick_actions/example/lib/main.dart

@@ -53,14 +53,16 @@ class _MyHomePageState extends State<MyHomePage> {
       const ShortcutItem(
         type: 'action_one',
         localizedTitle: 'Action one',
-        icon: 'AppIcon',
+        localizedSubtitle: 'Action one subtitle',
+        icon: 'icon_help',
       ),
       // NOTE: This second action icon will only work on Android.
       // In a real world project keep the same file name for both platforms.
       const ShortcutItem(
-          type: 'action_two',
-          localizedTitle: 'Action two',
-          icon: 'ic_launcher'),
+        type: 'action_two',
+        localizedTitle: 'Action two',
+        icon: 'ic_launcher',
+      ),
     ]).then((void _) {
       setState(() {
         if (shortcut == 'no action set') {

packages/quick_actions/quick_actions/example/pubspec.yaml

@@ -16,6 +16,16 @@ dependencies:
     # The example app is bundled with the plugin so we use a path dependency on
     # the parent directory to use the current plugin's version.
     path: ../
+
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+
+  quick_actions_platform_interface:
+    path: ../../../quick_actions/quick_actions_platform_interface
+  quick_actions_ios:
+    path: ../../../quick_actions/quick_actions_ios
 
 dev_dependencies:
   espresso: ^0.4.0

packages/quick_actions/quick_actions/pubspec.yaml

@@ -35,3 +35,8 @@ dev_dependencies:
 topics:
   - quick-actions
   - os-integration
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {quick_actions_ios: {path: ../../quick_actions/quick_actions_ios}, quick_actions_platform_interface: {path: ../../quick_actions/quick_actions_platform_interface}}

packages/quick_actions/quick_actions_android/example/pubspec.yaml

@@ -26,3 +26,4 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+

packages/quick_actions/quick_actions_android/pubspec.yaml

@@ -33,3 +33,4 @@ dev_dependencies:
 topics:
   - quick-actions
   - os-integration
+

packages/quick_actions/quick_actions_ios/CHANGELOG.md

@@ -1,5 +1,6 @@
-## NEXT
+## 1.1.2
 
+* Adds localizedSubtitle field for iOS quick actions.
 * Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.
 
 ## 1.1.1

packages/quick_actions/quick_actions_ios/example/pubspec.yaml

@@ -25,3 +25,8 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {quick_actions_ios: {path: ../../../quick_actions/quick_actions_ios}, quick_actions_platform_interface: {path: ../../../quick_actions/quick_actions_platform_interface}}

packages/quick_actions/quick_actions_ios/ios/quick_actions_ios/Sources/quick_actions_ios/QuickActionsPlugin.swift

@@ -90,18 +90,15 @@ public final class QuickActionsPlugin: NSObject, FlutterPlugin, IOSQuickActionsA
     -> UIApplicationShortcutItem?
   {
 
-    let type = shortcut.type
-    let localizedTitle = shortcut.localizedTitle
-
     let icon = (shortcut.icon).map {
       UIApplicationShortcutIcon(templateImageName: $0)
     }
 
     // type and localizedTitle are required.
     return UIApplicationShortcutItem(
-      type: type,
-      localizedTitle: localizedTitle,
-      localizedSubtitle: nil,
+      type: shortcut.type,
+      localizedTitle: shortcut.localizedTitle,
+      localizedSubtitle: shortcut.localizedSubtitle,
       icon: icon,
       userInfo: nil)
   }

packages/quick_actions/quick_actions_ios/ios/quick_actions_ios/Sources/quick_actions_ios/messages.g.swift

@@ -29,7 +29,7 @@ final class PigeonError: Error {
   var localizedDescription: String {
     return
       "PigeonError(code: \(code), message: \(message ?? "<nil>"), details: \(details ?? "<nil>")"
-  }
+      }
 }
 
 private func wrapResult(_ result: Any?) -> [Any?] {
@@ -59,9 +59,7 @@ private func wrapError(_ error: Any) -> [Any?] {
 }
 
 private func createConnectionError(withChannelName channelName: String) -> PigeonError {
-  return PigeonError(
-    code: "channel-error", message: "Unable to establish connection on channel: '\(channelName)'.",
-    details: "")
+  return PigeonError(code: "channel-error", message: "Unable to establish connection on channel: '\(channelName)'.", details: "")
 }
 
 private func isNullish(_ value: Any?) -> Bool {
@@ -81,25 +79,30 @@ struct ShortcutItemMessage {
   var type: String
   /// Localized title of the item.
   var localizedTitle: String
+  /// Localized subtitle of the item.
+  var localizedSubtitle: String? = nil
   /// Name of native resource to be displayed as the icon for this item.
   var icon: String? = nil
 
   // swift-format-ignore: AlwaysUseLowerCamelCase
   static func fromList(_ __pigeon_list: [Any?]) -> ShortcutItemMessage? {
     let type = __pigeon_list[0] as! String
     let localizedTitle = __pigeon_list[1] as! String
-    let icon: String? = nilOrValue(__pigeon_list[2])
+    let localizedSubtitle: String? = nilOrValue(__pigeon_list[2])
+    let icon: String? = nilOrValue(__pigeon_list[3])
 
     return ShortcutItemMessage(
       type: type,
       localizedTitle: localizedTitle,
+      localizedSubtitle: localizedSubtitle,
       icon: icon
     )
   }
   func toList() -> [Any?] {
     return [
       type,
       localizedTitle,
+      localizedSubtitle,
       icon,
     ]
   }
@@ -152,16 +155,10 @@ protocol IOSQuickActionsApi {
 class IOSQuickActionsApiSetup {
   static var codec: FlutterStandardMessageCodec { messagesPigeonCodec.shared }
   /// Sets up an instance of `IOSQuickActionsApi` to handle messages through the `binaryMessenger`.
-  static func setUp(
-    binaryMessenger: FlutterBinaryMessenger, api: IOSQuickActionsApi?,
-    messageChannelSuffix: String = ""
-  ) {
+  static func setUp(binaryMessenger: FlutterBinaryMessenger, api: IOSQuickActionsApi?, messageChannelSuffix: String = "") {
     let channelSuffix = messageChannelSuffix.count > 0 ? ".\(messageChannelSuffix)" : ""
     /// Sets the dynamic shortcuts for the app.
-    let setShortcutItemsChannel = FlutterBasicMessageChannel(
-      name:
-        "dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.setShortcutItems\(channelSuffix)",
-      binaryMessenger: binaryMessenger, codec: codec)
+    let setShortcutItemsChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.setShortcutItems\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec)
     if let api = api {
       setShortcutItemsChannel.setMessageHandler { message, reply in
         let args = message as! [Any?]
@@ -177,10 +174,7 @@ class IOSQuickActionsApiSetup {
       setShortcutItemsChannel.setMessageHandler(nil)
     }
     /// Removes all dynamic shortcuts.
-    let clearShortcutItemsChannel = FlutterBasicMessageChannel(
-      name:
-        "dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.clearShortcutItems\(channelSuffix)",
-      binaryMessenger: binaryMessenger, codec: codec)
+    let clearShortcutItemsChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.clearShortcutItems\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec)
     if let api = api {
       clearShortcutItemsChannel.setMessageHandler { _, reply in
         do {
@@ -198,8 +192,7 @@ class IOSQuickActionsApiSetup {
 /// Generated protocol from Pigeon that represents Flutter messages that can be called from Swift.
 protocol IOSQuickActionsFlutterApiProtocol {
   /// Sends a string representing a shortcut from the native platform to the app.
-  func launchAction(
-    action actionArg: String, completion: @escaping (Result<Void, PigeonError>) -> Void)
+  func launchAction(action actionArg: String, completion: @escaping (Result<Void, PigeonError>) -> Void)
 }
 class IOSQuickActionsFlutterApi: IOSQuickActionsFlutterApiProtocol {
   private let binaryMessenger: FlutterBinaryMessenger
@@ -212,13 +205,9 @@ class IOSQuickActionsFlutterApi: IOSQuickActionsFlutterApiProtocol {
     return messagesPigeonCodec.shared
   }
   /// Sends a string representing a shortcut from the native platform to the app.
-  func launchAction(
-    action actionArg: String, completion: @escaping (Result<Void, PigeonError>) -> Void
-  ) {
-    let channelName: String =
-      "dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsFlutterApi.launchAction\(messageChannelSuffix)"
-    let channel = FlutterBasicMessageChannel(
-      name: channelName, binaryMessenger: binaryMessenger, codec: codec)
+  func launchAction(action actionArg: String, completion: @escaping (Result<Void, PigeonError>) -> Void) {
+    let channelName: String = "dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsFlutterApi.launchAction\(messageChannelSuffix)"
+    let channel = FlutterBasicMessageChannel(name: channelName, binaryMessenger: binaryMessenger, codec: codec)
     channel.sendMessage([actionArg] as [Any?]) { response in
       guard let listResponse = response as? [Any?] else {
         completion(.failure(createConnectionError(withChannelName: channelName)))

packages/quick_actions/quick_actions_ios/lib/messages.g.dart

@@ -18,8 +18,7 @@ PlatformException _createConnectionError(String channelName) {
   );
 }
 
-List<Object?> wrapResponse(
-    {Object? result, PlatformException? error, bool empty = false}) {
+List<Object?> wrapResponse({Object? result, PlatformException? error, bool empty = false}) {
   if (empty) {
     return <Object?>[];
   }
@@ -34,6 +33,7 @@ class ShortcutItemMessage {
   ShortcutItemMessage({
     required this.type,
     required this.localizedTitle,
+    this.localizedSubtitle,
     this.icon,
   });
 
@@ -43,13 +43,17 @@ class ShortcutItemMessage {
   /// Localized title of the item.
   String localizedTitle;
 
+  /// Localized subtitle of the item.
+  String? localizedSubtitle;
+
   /// Name of native resource to be displayed as the icon for this item.
   String? icon;
 
   Object encode() {
     return <Object?>[
       type,
       localizedTitle,
+      localizedSubtitle,
       icon,
     ];
   }
@@ -59,11 +63,13 @@ class ShortcutItemMessage {
     return ShortcutItemMessage(
       type: result[0]! as String,
       localizedTitle: result[1]! as String,
-      icon: result[2] as String?,
+      localizedSubtitle: result[2] as String?,
+      icon: result[3] as String?,
     );
   }
 }
 
+
 class _PigeonCodec extends StandardMessageCodec {
   const _PigeonCodec();
   @override
@@ -79,7 +85,7 @@ class _PigeonCodec extends StandardMessageCodec {
   @override
   Object? readValueOfType(int type, ReadBuffer buffer) {
     switch (type) {
-      case 129:
+      case 129: 
         return ShortcutItemMessage.decode(readValue(buffer)!);
       default:
         return super.readValueOfType(type, buffer);
@@ -91,11 +97,9 @@ class IOSQuickActionsApi {
   /// Constructor for [IOSQuickActionsApi].  The [binaryMessenger] named argument is
   /// available for dependency injection.  If it is left null, the default
   /// BinaryMessenger will be used which routes to the host platform.
-  IOSQuickActionsApi(
-      {BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
+  IOSQuickActionsApi({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
       : __pigeon_binaryMessenger = binaryMessenger,
-        __pigeon_messageChannelSuffix =
-            messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
+        __pigeon_messageChannelSuffix = messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
   final BinaryMessenger? __pigeon_binaryMessenger;
 
   static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec();
@@ -104,10 +108,8 @@ class IOSQuickActionsApi {
 
   /// Sets the dynamic shortcuts for the app.
   Future<void> setShortcutItems(List<ShortcutItemMessage?> itemsList) async {
-    final String __pigeon_channelName =
-        'dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.setShortcutItems$__pigeon_messageChannelSuffix';
-    final BasicMessageChannel<Object?> __pigeon_channel =
-        BasicMessageChannel<Object?>(
+    final String __pigeon_channelName = 'dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.setShortcutItems$__pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
       __pigeon_channelName,
       pigeonChannelCodec,
       binaryMessenger: __pigeon_binaryMessenger,
@@ -129,10 +131,8 @@ class IOSQuickActionsApi {
 
   /// Removes all dynamic shortcuts.
   Future<void> clearShortcutItems() async {
-    final String __pigeon_channelName =
-        'dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.clearShortcutItems$__pigeon_messageChannelSuffix';
-    final BasicMessageChannel<Object?> __pigeon_channel =
-        BasicMessageChannel<Object?>(
+    final String __pigeon_channelName = 'dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsApi.clearShortcutItems$__pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
       __pigeon_channelName,
       pigeonChannelCodec,
       binaryMessenger: __pigeon_binaryMessenger,
@@ -159,25 +159,18 @@ abstract class IOSQuickActionsFlutterApi {
   /// Sends a string representing a shortcut from the native platform to the app.
   void launchAction(String action);
 
-  static void setUp(
-    IOSQuickActionsFlutterApi? api, {
-    BinaryMessenger? binaryMessenger,
-    String messageChannelSuffix = '',
-  }) {
-    messageChannelSuffix =
-        messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
+  static void setUp(IOSQuickActionsFlutterApi? api, {BinaryMessenger? binaryMessenger, String messageChannelSuffix = '',}) {
+    messageChannelSuffix = messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
     {
-      final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<
-              Object?>(
-          'dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsFlutterApi.launchAction$messageChannelSuffix',
-          pigeonChannelCodec,
+      final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
+          'dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsFlutterApi.launchAction$messageChannelSuffix', pigeonChannelCodec,
           binaryMessenger: binaryMessenger);
       if (api == null) {
         __pigeon_channel.setMessageHandler(null);
       } else {
         __pigeon_channel.setMessageHandler((Object? message) async {
           assert(message != null,
-              'Argument for dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsFlutterApi.launchAction was null.');
+          'Argument for dev.flutter.pigeon.quick_actions_ios.IOSQuickActionsFlutterApi.launchAction was null.');
           final List<Object?> args = (message as List<Object?>?)!;
           final String? arg_action = (args[0] as String?);
           assert(arg_action != null,
@@ -187,9 +180,8 @@ abstract class IOSQuickActionsFlutterApi {
             return wrapResponse(empty: true);
           } on PlatformException catch (e) {
             return wrapResponse(error: e);
-          } catch (e) {
-            return wrapResponse(
-                error: PlatformException(code: 'error', message: e.toString()));
+          }          catch (e) {
+            return wrapResponse(error: PlatformException(code: 'error', message: e.toString()));
           }
         });
       }

packages/quick_actions/quick_actions_ios/lib/quick_actions_ios.dart

@@ -47,6 +47,7 @@ class QuickActionsIos extends QuickActionsPlatform {
     return ShortcutItemMessage(
       type: item.type,
       localizedTitle: item.localizedTitle,
+      localizedSubtitle: item.localizedSubtitle,
       icon: item.icon,
     );
   }

packages/quick_actions/quick_actions_ios/pigeons/messages.dart

@@ -15,6 +15,7 @@ class ShortcutItemMessage {
   ShortcutItemMessage(
     this.type,
     this.localizedTitle,
+    this.localizedSubtitle,
     this.icon,
   );
 
@@ -24,6 +25,9 @@ class ShortcutItemMessage {
   /// Localized title of the item.
   String localizedTitle;
 
+  /// Localized subtitle of the item.
+  String? localizedSubtitle;
+
   /// Name of native resource to be displayed as the icon for this item.
   String? icon;
 }