Flutter Uploader
A plugin for creating and managing upload tasks. Supports iOS and Android.
This plugin is based on WorkManager in Android and NSURLSessionUploadTask in iOS to run upload task in background mode.
This plugin is inspired by flutter_downloader. Thanks to Hung Duy Ha & Flutter Community for great plugins and inspiration.
iOS integration
- Enable background mode.
AppDelegate changes
The plugin supports a background isolate. In order for plugins to work, you need to adjust your AppDelegate as follows:
import flutter_uploader
func registerPlugins(registry: FlutterPluginRegistry) {
GeneratedPluginRegistrant.register(with: registry)
}
@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
override func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
GeneratedPluginRegistrant.register(with: self)
SwiftFlutterUploaderPlugin.registerPlugins = registerPlugins
// Any further code.
}
}
Optional configuration:
- Configure maximum number of connection per host: the plugin allows 3 simultaneous http connection per host running at a moment by default. You can change this number by adding following codes to your
Info.plistfile.
<key>FUMaximumConnectionsPerHostkey>
<integer>3integer>
- Configure maximum number of concurrent upload operation: the plugin allows 3 simultaneous upload operation running at a moment by default. You can change this number by adding following codes to your
Info.plistfile.
<key>FUMaximumUploadOperationkey>
<integer>3integer>
- Configure request timeout: controls how long (in seconds) a task should wait for additional data to arrive before giving up
Info.plistfile.
<key>FUTimeoutInSecondskey>
<integer>3600integer>
Android integration
Optional configuration:
- Configure maximum number of concurrent tasks: the plugin depends on
WorkManagerlibrary andWorkManagerdepends on the number of available processor to configure the maximum number of tasks running at a moment. You can setup a fixed number for this configuration by adding following codes to yourAndroidManifest.xml:
<provider android:name="androidx.work.impl.WorkManagerInitializer" android:authorities="${applicationId}.workmanager-init" android:enabled="false" android:exported="false" /> <provider android:name="com.bluechilli.flutteruploader.FlutterUploaderInitializer" android:authorities="${applicationId}.flutter-upload-init" android:exported="false"> <meta-data android:name="com.bluechilli.flutterupload.MAX_CONCURRENT_TASKS" android:value="3" /> <meta-data android:name="com.bluechilli.flutteruploader.UPLOAD_CONNECTION_TIMEOUT_IN_SECONDS" android:value="3600" /> provider>
Usage
Import package:
import 'package:flutter_uploader/flutter_uploader.dart';
Configure a background isolate entry point
First, define a top-level function:
void backgroundHandler() {
// Needed so that plugin communication works.
WidgetsFlutterBinding.ensureInitialized();
// This uploader instance works within the isolate only.
FlutterUploader uploader = FlutterUploader();
// You have now access to:
uploader.progress.listen((progress) {
// upload progress
});
uploader.result.listen((result) {
// upload results
});
}
The backgroundHandler function needs to be either a static function or a top level function to be accessible as a Flutter entry point.
Once you have a function defined, configure it in your main FlutterUploader object like so:
FlutterUploader().setBackgroundHandler(backgroundHandler);
To see how it all works, check out the example.
Create new upload task:
multipart/form-data:
final taskId = await FlutterUploader().enqueue(
MultipartFormDataUpload(
url: "your upload link", //required: url to upload to
files: [FileItem(path: '/path/to/file', fieldname:"file")], // required: list of files that you want to upload
method: UploadMethod.POST, // HTTP method (POST or PUT or PATCH)
headers: {"apikey": "api_123456", "userkey": "userkey_123456"},
data: {"name": "john"}, // any data you want to send in upload request
tag: 'my tag', // custom tag which is returned in result/progress
),
);
binary uploads:
final taskId = await FlutterUploader().enqueue(
RawUpload(
url: "your upload link", // required: url to upload to
path: '/path/to/file', // required: list of files that you want to upload
method: UploadMethod.POST, // HTTP method (POST or PUT or PATCH)
headers: {"apikey": "api_123456", "userkey": "userkey_123456"},
tag: 'my tag', // custom tag which is returned in result/progress
),
);
The plugin will return a taskId which is unique for each upload. Hold onto it if you in order to cancel specific uploads.
listen for upload progress
final subscription = FlutterUploader().progress.listen((progress) {
//... code to handle progress
});
listen for upload result
final subscription = FlutterUploader().result.listen((result) {
//... code to handle result
}, onError: (ex, stacktrace) {
// ... code to handle error
});
when tasks are cancelled, it will send on onError handler as exception with status = cancelled
Upload results are persisted by the plugin and will be submitted on each .listen. It is advised to keep a list of processed uploads in App side and call clearUploads on the FlutterUploader plugin once they can be removed.
Cancel an upload task:
FlutterUploader().cancel(taskId: taskId);
Cancel all upload tasks:
FlutterUploader().cancelAll();
Clear Uploads
FlutterUploader().clearUploads()
![[question] How can you pass data to the background handler?](https://avatars.githubusercontent.com/u/20874747?v=4)
181 Jan 4, 2023
270 Dec 29, 2022
699 Jan 5, 2023
5 Nov 25, 2022
0 Nov 23, 2021
12 Oct 21, 2022
2 Jul 9, 2022
4 Mar 7, 2022
18 Nov 21, 2022
36 Dec 14, 2022
6 Nov 6, 2022
3 Jul 1, 2022
7 Oct 29, 2022
10 Dec 20, 2022
1 Dec 8, 2021
0 Jan 7, 2022
127 Dec 31, 2022
26 Nov 27, 2022