fluttercommunity · miquelbeltran · Dec 18, 2024 · Dec 18, 2024 · Dec 18, 2024 · Dec 18, 2024
diff --git a/packages/share_plus/share_plus/README.md b/packages/share_plus/share_plus/README.md
@@ -14,11 +14,11 @@ on iOS, or equivalent platform content sharing methods.
 
 ## Platform Support
 
-| Method        | Android | iOS | MacOS | Web | Linux | Windows |
-| :-----------: | :-----: | :-: | :---: | :-: | :---: | :----: |
-| `share`       |   ✅    | ✅  |  ✅   | ✅  |  ✅   |   ✅   |
-| `shareUri`    |   ✅    | ✅  |       |     |       |        |
-| `shareXFiles` |   ✅    | ✅  |  ✅   | ✅  |       |   ✅   |
+| Shared content | Android | iOS | MacOS | Web | Linux | Windows |
+| :------------: | :-----: | :-: | :---: | :-: | :---: | :-----: |
+| Text           |   ✅    | ✅  |  ✅   | ✅  |  ✅   |   ✅   |
+| URI            |   ✅    | ✅  |  ✅   | As text | As text | As text |
+| Files          |   ✅    | ✅  |  ✅   | ✅  |  ❌   |   ✅   |
 
 Also compatible with Windows and Linux by using "mailto" to share text via Email.
 
@@ -47,23 +47,30 @@ import 'package:share_plus/share_plus.dart';
 
 ### Share Text
 
-Invoke the static `share()` method anywhere in your Dart code.
+Access the `SharePlus` instance via `SharePlus.instance`.
+Then, invoke the `share()` method anywhere in your Dart code.
 
 ```dart
-Share.share('check out my website https://example.com');
+SharePlus.instance.share(
+  ShareParams(text: 'check out my website https://example.com')
+);
 ```
 
-The `share` method also takes an optional `subject` that will be used when
-sharing to email.
+The `share()` method requires the `ShareParams` object,
+which contains the content to share.
 
-```dart
-Share.share('check out my website https://example.com', subject: 'Look what I made!');
-```
+These are some of the accepted parameters of the `ShareParams` class:
+
+- `text`: text to share.
+- `title`: content or share-sheet title (if supproted).
+- `subject`: email subject (if supported).
+
+Check the class documentation for more details.
 
 `share()` returns `status` object that allows to check the result of user action in the share sheet.
 
 ```dart
-final result = await Share.share('check out my website https://example.com');
+final result = await SharePlus.instance.share(params);
 
 if (result.status == ShareResultStatus.success) {
     print('Thank you for sharing my website!');
@@ -72,18 +79,31 @@ if (result.status == ShareResultStatus.success) {
 
 ### Share Files
 
-To share one or multiple files, invoke the static `shareXFiles` method anywhere in your Dart code. The method returns a `ShareResult`. Optionally, you can pass `subject`, `text` and `sharePositionOrigin`.
+To share one or multiple files, provide the `files` list in `ShareParams`.
+Optionally, you can pass `title`, `text` and `sharePositionOrigin`.
 
 ```dart
-final result = await Share.shareXFiles([XFile('${directory.path}/image.jpg')], text: 'Great picture');
+final params = ShareParams(
+  text: 'Great picture',
+  files: [XFile('${directory.path}/image.jpg')], 
+);
+
+final result = await SharePlus.instance.share(params);
 
 if (result.status == ShareResultStatus.success) {
     print('Thank you for sharing the picture!');
 }
 ```
 
 ```dart
-final result = await Share.shareXFiles([XFile('${directory.path}/image1.jpg'), XFile('${directory.path}/image2.jpg')]);
+final params = ShareParams(
+  files: [
+    XFile('${directory.path}/image1.jpg'), 
+    XFile('${directory.path}/image2.jpg'),
+  ],
+);
+
+final result = await SharePlus.instance.share(params);
 
 if (result.status == ShareResultStatus.dismissed) {
     print('Did you not like the pictures?');
@@ -96,15 +116,13 @@ See [Can I Use - Web Share API](https://caniuse.com/web-share) to understand
 which browsers are supported. This builds on the [`cross_file`](https://pub.dev/packages/cross_file)
 package.
 
-
-```dart
-Share.shareXFiles([XFile('assets/hello.txt')], text: 'Great picture');
-```
-
 File downloading fallback mechanism for web can be disabled by setting:
 
 ```dart
-Share.downloadFallbackEnabled = false;
+ShareParams(
+  // rest of params
+  downloadFallbackEnabled: false,
+)
 ```
 
 #### Share Data
@@ -114,7 +132,12 @@ You can also share files that you dynamically generate from its data using [`XFi
 To set the name of such files, use the `fileNameOverrides` parameter, otherwise the file name will be a random UUID string.
 
 ```dart
-Share.shareXFiles([XFile.fromData(utf8.encode(text), mimeType: 'text/plain')], fileNameOverrides: ['myfile.txt']);
+final params = ShareParams(
+  files: [XFile.fromData(utf8.encode(text), mimeType: 'text/plain')], 
+  fileNameOverrides: ['myfile.txt']
+);
+
+SharePlus.instance.share(params);
 ```
 
 > [!CAUTION]
@@ -123,10 +146,13 @@ Share.shareXFiles([XFile.fromData(utf8.encode(text), mimeType: 'text/plain')], f
 ### Share URI
 
 iOS supports fetching metadata from a URI when shared using `UIActivityViewController`.
-This special method is only properly supported on iOS.
+This special functionality is only properly supported on iOS.
+On other platforms, the URI will be shared as plain text.
 
 ```dart
-Share.shareUri(uri: uri);
+final params = ShareParams(uri: uri);
+
+SharePlus.instance.share(params);
 ```
 
 ### Share Results
@@ -201,15 +227,52 @@ Builder(
 // _onShare method:
 final box = context.findRenderObject() as RenderBox?;
 
-await Share.share(
-  text,
-  subject: subject,
-  sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
+await SharePlus.instance.share(
+  ShareParams(
+    text: text,
+    sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
+  )
 );
 ```
 
 See the `main.dart` in the `example` for a complete example.
 
+## Migrating from `Share.share()` to `SharePlus.instance.share()`
+
+The static methods `Share.share()`, `Share.shareUri()` and `Share.shareXFiles()`
+have been deprecated in favor of the `SharePlus.instance.share(params)`.
+
+To convert code using `Share.share()` to the new `SharePlus` class:
+
+1. Wrap the current parameters in a `ShareParams` object.
+2. Change the call to `SharePlus.instance.share()`.
+
+e.g.
+
+```dart
+Share.share("Shared text");
+
+Share.shareUri("http://example.com");
+
+Share.shareXFiles(files);
+```
+
+Becomes:
+
+```dart
+SharePlus.instance.share(
+  ShareParams(text: "Shared text"),
+);
+
+SharePlus.instance.share(
+  ShareParams(uri: "http://example.com"),
+);
+
+SharePlus.instance.share(
+  ShareParams(files: files),
+);
+```
+
 ## Learn more
 
 - [API Documentation](https://pub.dev/documentation/share_plus/latest/share_plus/share_plus-library.html)
diff --git a/...s/share_plus/android/src/main/kotlin/dev/fluttercommunity/plus/share/MethodCallHandler.kt b/...s/share_plus/android/src/main/kotlin/dev/fluttercommunity/plus/share/MethodCallHandler.kt
@@ -1,10 +1,8 @@
 package dev.fluttercommunity.plus.share
 
 import android.os.Build
-import io.flutter.BuildConfig
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
-import java.io.IOException
 
 /** Handles the method calls for the plugin.  */
 internal class MethodCallHandler(
@@ -24,35 +22,13 @@ internal class MethodCallHandler(
 
         try {
             when (call.method) {
-                "shareUri" -> {
-                    share.share(
-                        call.argument<Any>("uri") as String,
-                        subject = null,
-                        withResult = isWithResult,
-                    )
-                    success(isWithResult, result)
-                }
-
                 "share" -> {
                     share.share(
-                        call.argument<Any>("text") as String,
-                        call.argument<Any>("subject") as String?,
-                        isWithResult,
-                    )
-                    success(isWithResult, result)
-                }
-
-                "shareFiles" -> {
-                    share.shareFiles(
-                        call.argument<List<String>>("paths")!!,
-                        call.argument<List<String>?>("mimeTypes"),
-                        call.argument<String?>("text"),
-                        call.argument<String?>("subject"),
-                        isWithResult,
+                        arguments = call.arguments<Map<String, Any>>()!!,
+                        withResult = isWithResult,
                     )
                     success(isWithResult, result)
                 }
-
                 else -> result.notImplemented()
             }
         } catch (e: Throwable) {