Receive Sharing Intent

https://pub.dev/packages/receive_sharing_intent
Admin
A Flutter plugin that enables apps to receive sharing photos, videos, text, URLs or any file types...
Tokens:7,815
Snippets:116
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example pubspec.yaml Entry

Source: https://pub.dev/packages/receive_sharing_intent/install

This is how the dependency will appear in your pubspec.yaml file after running the add command.

```yaml
dependencies:
  receive_sharing_intent: ^1.8.1
```

--------------------------------

### Podfile Configuration for Share Extension

Source: https://pub.dev/packages/receive_sharing_intent

Modify your Podfile to include the Share Extension target and ensure all iOS pods are installed.

```ruby
...
target 'Runner' do
  use_frameworks!
  use_modular_headers!

  flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))

  # Share Extension is name of Extension which you created which is in this case 'Share Extension'
  target 'Share Extension' do
    inherit! :search_paths
  end
end
...
```

--------------------------------

### Import receive_sharing_intent in Dart

Source: https://pub.dev/packages/receive_sharing_intent/install

Import the package into your Dart files to start using its functionality.

```dart
import 'package:receive_sharing_intent/receive_sharing_intent.dart';
```

--------------------------------

### Dart File Convention Example

Source: https://pub.dev/packages/receive_sharing_intent/score

This code snippet demonstrates the use of the 'part of' directive, which is a Dart file convention. Ensure you are using lints_core and run 'flutter analyze' for analysis.

```dart
part of receive_sharing_intent;

```

--------------------------------

### Receive Shared Text and URLs

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/score

This snippet demonstrates how to get shared text and URLs. Ensure the plugin is initialized before calling this method.

```dart
Future<void> getSharedText() async {
  String? sharedData = await ReceiveSharingIntent.getSharedText();
  print("Shared data is $sharedData");
}
```

--------------------------------

### Handle Shared Media and Text Intents

Source: https://pub.dev/packages/receive_sharing_intent

Listen to media sharing intents while the app is in memory or closed. This snippet demonstrates how to get initial media and ongoing streams of shared content.

```dart
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:receive_sharing_intent/receive_sharing_intent.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late StreamSubscription _intentSub;
  final _sharedFiles = <SharedMediaFile>[];

  @override
  void initState() {
    super.initState();

    // Listen to media sharing coming from outside the app while the app is in the memory.
    _intentSub = ReceiveSharingIntent.instance.getMediaStream().listen((value) {
      setState(() {
        _sharedFiles.clear();
        _sharedFiles.addAll(value);

        print(_sharedFiles.map((f) => f.toMap()));
      });
    }, onError: (err) {
      print("getIntentDataStream error: $err");
    });

    // Get the media sharing coming from outside the app while the app is closed.
    ReceiveSharingIntent.instance.getInitialMedia().then((value) {
      setState(() {
        _sharedFiles.clear();
        _sharedFiles.addAll(value);
        print(_sharedFiles.map((f) => f.toMap()));

        // Tell the library that we are done processing the intent.
        ReceiveSharingIntent.instance.reset();
      });
    });
  }

  @override
  void dispose() {
    _intentSub.cancel();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    const textStyleBold = const TextStyle(fontWeight: FontWeight.bold);
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            children: <Widget>[
              Text("Shared files:", style: textStyleBold),
              Text(_sharedFiles
                      .map((f) => f.toMap())
                      .join(",\n****************\n")),
            ],
          ),
        ),
      ),
    );
  }
}

```

--------------------------------

### Handle Incoming Shares

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/score

This snippet demonstrates how to listen for incoming shares while the app is running. It's useful for real-time updates.

```dart
ReceiveSharingIntent.getMediaStream().listen((List<SharedMediaFile> sharedMedia) {
  sharedMedia.forEach((file) {
    print("Path: " + file.path + "\nType: " + file.type + "\nThumbnail: " + file.thumbnail);
  });
}, onError: (err) {
  print("Error: $err");
});
```

--------------------------------

### Share Extension Info.plist Configuration

Source: https://pub.dev/packages/receive_sharing_intent

Configure the Info.plist for your Share Extension to define supported media types and activation rules for sharing text, URLs, images, videos, and files.

```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>AppGroupId</key>
    <string>$(CUSTOM_GROUP_ID)</string>
	<key>CFBundleVersion</key>
	<string>$(FLUTTER_BUILD_NUMBER)</string>
	<key>NSExtension</key>
	<dict>
		<key>NSExtensionAttributes</key>
        <dict>
            <key>PHSupportedMediaTypes</key>
               <array>
                    <!--TODO: Add this flag, if you want to support sharing video into your app-->
                   <string>Video</string>
                   <!--TODO: Add this flag, if you want to support sharing images into your app-->
                   <string>Image</string>
               </array>
            <key>NSExtensionActivationRule</key>
            <dict>
                <!--TODO: Add this flag, if you want to support sharing text into your app-->
                <key>NSExtensionActivationSupportsText</key>
                <true/>
                <!--TODO: Add this tag, if you want to support sharing urls into your app-->
            	<key>NSExtensionActivationSupportsWebURLWithMaxCount</key>
            	<integer>1</integer>
            	<!--TODO: Add this flag, if you want to support sharing images into your app-->
                <key>NSExtensionActivationSupportsImageWithMaxCount</key>
                <integer>100</integer>
                <!--TODO: Add this flag, if you want to support sharing video into your app-->
                <key>NSExtensionActivationSupportsMovieWithMaxCount</key>
                <integer>100</integer>
                <!--TODO: Add this flag, if you want to support sharing other files into your app-->
                <!--Change the integer to however many files you want to be able to share at a time-->
				<key>NSExtensionActivationSupportsFileWithMaxCount</key>
				<integer>1</integer>
            </dict>
        </dict>
		<key>NSExtensionMainStoryboard</key>
		<string>MainInterface</string>
		<key>NSExtensionPointIdentifier</key>
		<string>com.apple.share-services</string>
	</dict>
  </dict>
</plist>
```

--------------------------------

### Runner Info.plist Configuration

Source: https://pub.dev/packages/receive_sharing_intent

Add App Group and URL scheme configurations to your main application's Info.plist.

```xml
...
<key>AppGroupId</key>
<string>$(CUSTOM_GROUP_ID)</string>
<key>CFBundleURLTypes</key>
	<array>
		<dict>
			<key>CFBundleTypeRole</key>
			<string>Editor</string>
			<key>CFBundleURLSchemes</key>
			<array>
				<string>ShareMedia-$(PRODUCT_BUNDLE_IDENTIFIER)</string>
			</array>
		</dict>
	</array>

<key>NSPhotoLibraryUsageDescription</key>
<string>To upload photos, please allow permission to access your photo library.</string>
...
```

--------------------------------

### Handle Incoming Text Shares

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/score

This snippet demonstrates how to listen for incoming text shares while the app is running.

```dart
ReceiveSharingIntent.getTextStream().listen((String sharedData) {
  print("Shared data is $sharedData");
}, onError: (err) {
  print("Error: $err");
});
```

--------------------------------

### Handle Incoming Media Shares in Flutter

Source: https://pub.dev/packages/receive_sharing_intent/example

This snippet demonstrates how to listen for media sharing intents while the app is in memory using a stream. It also shows how to retrieve initial media shares when the app is launched from a closed state. Remember to call reset() after processing the initial intent.

```dart
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:receive_sharing_intent/receive_sharing_intent.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late StreamSubscription _intentSub;
  final _sharedFiles = <SharedMediaFile>[];

  @override
  void initState() {
    super.initState();

    // Listen to media sharing coming from outside the app while the app is in the memory.
    _intentSub = ReceiveSharingIntent.instance.getMediaStream().listen((value) {
      setState(() {
        _sharedFiles.clear();
        _sharedFiles.addAll(value);

        print(_sharedFiles.map((f) => f.toMap()));
      });
    }, onError: (err) {
      print("getIntentDataStream error: $err");
    });

    // Get the media sharing coming from outside the app while the app is closed.
    ReceiveSharingIntent.instance.getInitialMedia().then((value) {
      setState(() {
        _sharedFiles.clear();
        _sharedFiles.addAll(value);
        print(_sharedFiles.map((f) => f.toMap()));

        // Tell the library that we are done processing the intent.
        ReceiveSharingIntent.instance.reset();
      });
    });
  }

  @override
  void dispose() {
    _intentSub.cancel();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    const textStyleBold = const TextStyle(fontWeight: FontWeight.bold);
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            children: <Widget>[
              Text("Shared files:", style: textStyleBold),
              Text(_sharedFiles
                  .map((f) => f.toMap())
                  .join(",\n****************\n")),
            ],
          ),
        ),
      ),
    );
  }
}

```

--------------------------------

### Add receive_sharing_intent Dependency

Source: https://pub.dev/packages/receive_sharing_intent/install

Run this command to add the package to your Flutter project's dependencies.

```bash
$ flutter pub add receive_sharing_intent
```

--------------------------------

### Set Mock Values for Testing

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/changelog

Use this method to set mock values for testing purposes. It allows specifying initial media and a media stream.

```dart
ReceiveSharingIntent.setMockValues(
      initialMedia: [],
      mediaStream: Stream.empty(),
    );
```

--------------------------------

### Receive Shared Media Files

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/score

This snippet shows how to retrieve shared media files (images, videos, etc.). It returns a list of SharedMediaFile objects.

```dart
Future<void> getSharedMedia() async {
  List<SharedMediaFile> sharedMedia = await ReceiveSharingIntent.getInitialSharedMedia();
  sharedMedia.forEach((file) {
    print("Path: " + file.path + "\nType: " + file.type + "\nThumbnail: " + file.thumbnail);
  });
}
```

--------------------------------

### Runner Entitlements Configuration

Source: https://pub.dev/packages/receive_sharing_intent

Configure associated domains in your Runner target's entitlements file to support opening URLs into your app.

```xml
....
    <!--TODO:  Add this tag, if you want support opening urls into your app-->
    <key>com.apple.developer.associated-domains</key>
    <array>
        <string>applinks:example.com</string>
    </array>
....

```

--------------------------------

### Configure Android Manifest for URL Sharing

Source: https://pub.dev/packages/receive_sharing_intent

Add this intent filter to your android/app/src/main/AndroidManifest.xml to enable opening URLs into your app.

```xml
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
.....
 <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

  <application
        android:name="io.flutter.app.FlutterApplication"
        ...
        >
<!--Set activity launchMode to singleTask, if you want to prevent creating new activity instance everytime there is a new intent.-->
    <activity
            android:name=".MainActivity"
            android:launchMode="singleTask"
            android:theme="@style/LaunchTheme"
            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
            android:hardwareAccelerated="true"
            android:windowSoftInputMode="adjustResize">

            <!--TODO:  Add this filter, if you want support opening urls into your app-->
            <intent-filter>
               <action android:name="android.intent.action.VIEW" />
               <category android:name="android.intent.category.DEFAULT" />
               <category android:name="android.intent.category.BROWSABLE" />
               <data
                   android:scheme="https"
                   android:host="example.com"
                   android:pathPrefix="/invite"/>
            </intent-filter>

            <!--TODO:  Add this filter, if you want support opening files into your app-->
            <intent-filter>
              <action android:name="android.intent.action.VIEW" />
              <category android:name="android.intent.category.DEFAULT" />
              <data
                   android:mimeType="*/*"
                   android:scheme="content" />
            </intent-filter>

             <!--TODO: Add this filter, if you want to support sharing text into your app-->
            <intent-filter>
               <action android:name="android.intent.action.SEND" />
               <category android:name="android.intent.category.DEFAULT" />
               <data android:mimeType="text/*" />
            </intent-filter>

            <!--TODO: Add this filter, if you want to support sharing images into your app-->
            <intent-filter>
                <action android:name="android.intent.action.SEND" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="image/*" />
            </intent-filter>

            <intent-filter>
                <action android:name="android.intent.action.SEND_MULTIPLE" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="image/*" />
            </intent-filter>

             <!--TODO: Add this filter, if you want to support sharing videos into your app-->
            <intent-filter>
                <action android:name="android.intent.action.SEND" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="video/*" />
            </intent-filter>
            <intent-filter>
                <action android:name="android.intent.action.SEND_MULTIPLE" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="video/*" />
            </intent-filter>

            <!--TODO: Add this filter, if you want to support sharing any type of files-->
            <intent-filter>
                <action android:name="android.intent.action.SEND" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="*/*" />
            </intent-filter>
            <intent-filter>
                <action android:name="android.intent.action.SEND_MULTIPLE" />
                <category android:name="android.intent.category.DEFAULT" />
                <data android:mimeType="*/*" />
            </intent-filter>
      </activity>

  </application>
</manifest>
....

```

--------------------------------

### ShareViewController Implementation

Source: https://pub.dev/packages/receive_sharing_intent

Implement the ShareViewController by inheriting from RSIShareViewController and optionally overriding the shouldAutoRedirect method.

```swift
// If you get no such module 'receive_sharing_intent' error. 
// Go to Build Phases of your Runner target and
// move `Embed Foundation Extension` to the top of `Thin Binary`. 
import receive_sharing_intent

class ShareViewController: RSIShareViewController {
      
    // Use this method to return false if you don't want to redirect to host app automatically.
    // Default is true
    override func shouldAutoRedirect() -> Bool {
        return false
    }
    
}

```

--------------------------------

### Update Info.plist for Media Sharing

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/changelog

When sharing any type of file, update your project's `ios/Runner/Info.plist` to change 'SharePhotos' to 'ShareMedia'.

```xml
<key>CFBundleURLSchemes</key>
    <array>
    	<string>ShareMedia</string>

```

--------------------------------

### Disable Automatic Share Extension Closing

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/changelog

Return false from this method to prevent the share extension from automatically redirecting to the host app. The default behavior is true.

```swift
class ShareViewController: RSIShareViewController {
    
    // Use this method to return false if you don't want to redirect to host app automatically.
    // Default is true
    override func shouldAutoRedirect() -> Bool {
        return false
    }
    
}
```

--------------------------------

### Add receive_sharing_intent Dependency

Source: https://pub.dev/packages/receive_sharing_intent

Add the receive_sharing_intent plugin as a dependency in your pubspec.yaml file to integrate it into your Flutter project.

```yaml
dependencies:
  receive_sharing_intent: ^latest

```

--------------------------------

### Clear Shared Media Intent

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/score

This snippet shows how to clear the shared media intent after processing. This is important to prevent re-processing the same share.

```dart
await ReceiveSharingIntent.clearSharedMedia();
```

--------------------------------

### Clear Shared Text Intent

Source: https://pub.dev/packages/receive_sharing_intent/versions/1.8.0/score

This snippet shows how to clear the shared text intent after processing.

```dart
await ReceiveSharingIntent.clearSharedText();
```
Tokens:
Raw