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.plist file.
<!-- changes this number to configure the maximum number of concurrent tasks --><key>FUMaximumConnectionsPerHost</key><integer>3</integer>
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.plist file.
<!-- changes this number to configure the maximum number of concurrent tasks --><key>FUMaximumUploadOperation</key><integer>3</integer>
Configure request timeout: controls how long (in seconds) a task should wait for additional data to arrive before giving up Info.plist file.
<!-- changes this number to configure the request timeout --><key>FUTimeoutInSeconds</key><integer>3600</integer>
Android integration
Optional configuration:
Configure maximum number of concurrent tasks: the plugin depends on WorkManager library and WorkManager depends 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 your AndroidManifest.xml:
<providerandroid:name="androidx.work.impl.WorkManagerInitializer"android:authorities="${applicationId}.workmanager-init"android:enabled="false"android:exported="false" /><providerandroid:name="com.bluechilli.flutteruploader.FlutterUploaderInitializer"android:authorities="${applicationId}.flutter-upload-init"android:exported="false"><!-- changes this number to configure the maximum number of concurrent tasks --><meta-dataandroid:name="com.bluechilli.flutterupload.MAX_CONCURRENT_TASKS"android:value="3" /><!-- changes this number to configure connection timeout for the upload http request --><meta-dataandroid:name="com.bluechilli.flutteruploader.UPLOAD_CONNECTION_TIMEOUT_IN_SECONDS"android:value="3600" /></provider>
voidbackgroundHandler() {
// 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:
final taskId = awaitFlutterUploader().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 = awaitFlutterUploader().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.