Create a DownloadTask to define where to get your file from, where to store it, and how you want to monitor the download, then call FileDownloader().download and wait for the result. Background_downloader uses URLSessions on iOS and DownloadWorker on Android, so tasks will complete also when your app is in the background. The download behavior is highly consistent across all supported platforms: iOS, Android, MacOS, Windows and Linux.
Monitor progress by passing an onProgress listener, and monitor detailed status updates by passing an onStatus listener to the download call. Alternatively, monitor tasks centrally using an event listener or callbacks and call enqueue to start the task.
Optionally, keep track of task status and progress in a persistent database, and show mobile notifications to keep the user informed and in control when your app is in the background.
To upload a file, create an UploadTask and call upload. To make a regular server request, create a Request and call request.
The plugin supports headers, retries, requiring WiFi before starting the up/download, user-defined metadata and GET and POST http(s) requests. You can manage the tasks in the queue (e.g. cancel, pause and resume), and have different handlers for updates by group of tasks. Downloaded files can be moved to shared storage to make them available outside the app.
No setup is required for Android (except when using notifications), Windows and Linux, and only minimal setup for iOS and MacOS.
- Basic use
- Central monitoring and tracking in a persistent database
- Notifications
- Shared and scoped storage
- Uploads
- Managing tasks in the queue
- Server requests
- Optional parameters
A DownloadTask or UploadTask (both subclasses of Task) defines one download or upload. It contains the url, the file name and location, what updates you want to receive while the task is in progress, etc. The FileDownloader class is the entrypoint for all calls. To download a file:
final task = DownloadTask(
url: 'https://google.com',
filename: 'testfile.txt'); // define your task
final result = await FileDownloader().download(task); // do the download and wait for result
The result will be a TaskStatus that represents how the download ended: .complete, .failed, .canceled or .notFound.
If you want to monitor progress during the download itself (e.g. for a large file), then add a progress callback that takes a double as its argument:
final result = await FileDownloader().download(task,
onProgress: (progress) => print('Progress update: $progress'));
Progress updates start with 0.0 when the actual download starts (which may be in the future, e.g. if waiting for a WiFi connection), and will be sent periodically, not more than twice per second per task. If a task completes successfully you will receive a final progress update with a progress value of 1.0 (progressComplete). Failed tasks generate progress of progressFailed (-1.0), canceled tasks progressCanceled (-2.0), notFound tasks progressNotFound (-3.0), waitingToRetry tasks progressWaitingToRetry (-4.0) and paused tasks progressPaused (-5.0).
If you want to monitor status changes while the download is underway (i.e. not only the final state, which you will receive as the result of the download call) you can add a status change callback that takes the status as an argument:
final result = await FileDownloader().download(task,
onStatus: (status) => print('Status update: $status'));
The status will follow a sequence of .enqueued (waiting to execute), .running (actively downloading) and then one of the final states mentioned before, or .waitingToRetry if retries are enabled and the task failed.
In the DownloadTask and UploadTask objects, the filename of the task refers to the filename without directory. To store the task in a specific directory, add the directory parameter to the task. That directory is relative to the base directory, so cannot start with a /. By default, the base directory is the directory returned by the call to getApplicationDocumentsDirectory() of the path_provider package, but this can be changed by also passing a baseDirectory parameter (BaseDirectory.temporary for the directory returned by getTemporaryDirectory(), BaseDirectory.applicationSupport for the directory returned by getApplicationSupportDirectory() and BaseDirectory.applicationLibrary for the directory returned by getLibraryDirectory() on iOS and MacOS, or subdir 'Library' of the directory returned by getApplicationSupportDirectory() on other platforms).
So, to store a file named 'testfile.txt' in the documents directory, subdirectory 'my/subdir', define the task as follows:
final task = DownloadTask(
url: 'https://google.com',
filename: 'testfile.txt',
directory: 'my/subdir');
To store that file in the temporary directory:
final task = DownloadTask(
url: 'https://google.com',
filename: 'testfile.txt',
directory: 'my/subdir',
baseDirectory: BaseDirectory.temporary);
The downloader will only store the file upon success (so there will be no partial files saved), and if so, the destination is overwritten if it already exists, and all intermediate directories will be created if needed.
Note: the reason you cannot simply pass a full absolute directory path to the downloader is that the location of the app's documents directory may change between application starts (on iOS), and may therefore fail for downloads that complete while the app is suspended. You should therefore never store permanently, or hard-code, an absolute path.
To download a batch of files and wait for completion of all, create a List of DownloadTask objects and call downloadBatch:
final result = await FileDownloader().downloadBatch(tasks);
The result is a Batch object that contains the result for each task in .results. You can use .numSucceeded and .numFailed to check if all files in the batch downloaded successfully, and use .succeeded or .failed to iterate over successful or failed tasks within the batch. If you want to get progress updates for the batch (in terms of how many files have been downloaded) then add a callback:
final result = await FileDownloader().downloadBatch(tasks, batchProgressCallback: (succeeded, failed) {
print('$succeeded files succeeded, $failed have failed');
print('Progress is ${(succeeded + failed) / tasks.length} %');
});
The callback will be called upon completion of each task (whether successful or not), and will start with (0, 0) before any downloads start, so you can use that to start a progress indicator.
To also monitor status and progress for each file in the batch, add a taskStatusCallback (taking Task and TaskStatus as arguments) and/or a taskProgressCallback (taking Task` and a double as arguments).
For uploads, create a List of UploadTask objects and call uploadBatch - everything else is the same.
Instead of monitoring in the download call, you may want to use a centralized task monitoring approach, and/or keep track of tasks in a database. This is helpful for instance if:
- You start download in multiple locations in your app, but want to monitor those in one place, instead of defining
onStatusandonProgressfor every call todownload - You have different groups of tasks, and each group needs a different monitor
- You want to keep track of the status and progress of tasks in a persistent database that you query
- Your downloads take long, and your user may switch away from your app for a long time, which causes your app to get suspended by the operating system. The downloads continue in the background and will finish eventually, but when your app restarts from a suspended state, the result
Futurethat you were awaiting when you calleddownloadmay no longer be 'alive', and you will therefore miss the completion of the downloads that happened while suspended. This situation is uncommon, as the app will typically remain alive for several minutes even when moving to the background, but if you find this to be a problem for your use case, then you should process status and progress updates for long running background tasks centrally.
Central monitoring can be done by listening to an updates stream, or by registering callbacks. In both cases you now use enqueue instead of download or upload. enqueue returns almost immediately with a bool to indicate if the Task was successfully enqueued. Monitor status changes and act when a Task completes via the listener or callback.
To ensure your callbacks or listener capture events that may have happened when your app was suspended in the background, call resumeFromBackground right after registering your callbacks or listener.
In summary, to track your tasks persistently, follow these steps in order:
- Register an event listener or callback(s) to process status and progress updates
- call
await FileDownloader().trackTasks()if you want to track the tasks in a persistent database - call
await FileDownloader().resumeFromBackground()to ensure events that happened while your app was in the background are processed
The rest of this section details event listeners, callbacks and the database in detail.
Listen to updates from the downloader by listening to the updates stream, and process those updates centrally. For example, the following creates a listener to monitor status and progress updates for downloads, and then enqueues a task as an example:
final subscription = FileDownloader().updates.listen((update) {
if (update is TaskStatusUpdate) {
print('Status update for ${update.task} with status ${update.status}');
} else if (update is TaskProgressUpdate) {
print('Progress update for ${update.task} with progress ${update.progress}');
});
// define the task
final task = DownloadTask(
url: 'https://google.com',
filename: 'google.html',
updates:
Updates.statusAndProgress); // needed to also get progress updates
// enqueue the download
final successFullyEnqueued = await FileDownloader().enqueue(task);
// updates will be sent to your subscription listener
Note that successFullyEnqueued only refers to the enqueueing of the download task, not its result, which must be monitored via the listener. Also note that in order to get progress updates the task must set its updates field to a value that includes progress updates. In the example, we are asking for both status and progress updates, but other combinations are possible. For example, if you set updates to Updates.status then the task will only generate status updates and no progress updates. You define what updates to receive on a task by task basis via the Task.updates field, which defaults to status updates only.
You can start your subscription in a convenient place, like a widget's initState, and don't forget to cancel your subscription to the stream using subscription.cancel(). Note the stream can only be listened to once.
Instead of listening to the updates stream you can register a callback for status updates, and/or a callback for progress updates. This may be the easiest way if you want different callbacks for different groups.
The TaskStatusCallback receives the Task and the updated TaskStatus, so a simple callback function is:
void taskStatusCallback(
Task task, TaskStatus status) {
print('taskStatusCallback for $task with status $status');
}
The TaskProgressCallback receives the Task and progess as a double, so a simple callback function is:
void taskProgressCallback(Task task, double progress) {
print('taskProgressCallback for $task with progress $progress');
}
A basic file download with just status monitoring (no progress) then requires registering the central callback, and a call to enqueue to start the download:
FileDownloader().registerCallbacks(taskStatusCallback: taskStatusCallback);
final successFullyEnqueued = await FileDownloader().enqueue(
DownloadTask(url: 'https://google.com', filename: 'google.html'));
You define what updates to receive on a task by task basis via the Task.updates field, which defaults to status updates only. If you register a callback for a type of task, updates are provided only through that callback and will not be posted on the updates stream.
Note that all tasks will call the same callback, unless you register separate callbacks for different groups and set your Task.group field accordingly.
To keep track of the status and progress of all tasks, even after they have completed, activate tracking by calling trackTasks() and use the database field to query. For example:
// at app startup, after registering listener or callback, start tracking
await FileDownloader().trackTasks();
// somewhere else: enqueue a download
final task = DownloadTask(
url: 'https://google.com',
filename: 'testfile.txt');
final successfullyEnqueued = await FileDownloader().enqueue(task);
// somewhere else: query the task status by getting a `TaskRecord`
// from the database
final record = await FileDownloader().database.recordForId(task.taskId);
print('Taskid ${record.taskId} with task ${record.task} has '
'status ${record.taskStatus} and progress ${record.progress}'
You can interact with the database using
allRecords, allRecordsOlderThan, recordForId,
deleteAllRecords,
deleteRecordWithId etc. Note that only tasks that you asked to be tracked (using trackTasks, which activates tracking for all tasks in a group) will be in the database. All active tasks in the queue, regardless of tracking, can be queried via the FileDownloader().taskForId call etc, but those will only return the task itself, not its status or progress, as those are expected to be monitored via listener or callback. Note: tasks that are started using download, upload, batchDownload or batchUpload are assigned a special group name 'await', as callbacks for these tasks are handled within the FileDownloader. If you want to track those tasks in the database, call FileDownloader().trackTasks(FileDownloader.awaitGroup) at the start of your app.
On iOS and Android, for downloads only, the downloader can generate notifications to keep the user informed of progress also when the app is in the background, and allow pause/resume and cancellation of an ongoing download from those notifications.
Configure notifications by calling FileDownloader().configureNotification and supply a TaskNotification object for different states. For example, the following configures notifications to show only when actively running (i.e. download in progress), disappearing when the download completes or ends with an error. It will also show a progress bar and a 'cancel' button, and will substitute {filename} with the actual filename of the file being downloaded.
FileDownloader().configureNotification(
running: TaskNotification('Downloading', 'file: {filename}'),
progressBar: true)
To also show a notifications for other states, add a TaskNotification for complete, error and/or paused. If paused is configured and the task can be paused, a 'Pause' button will show for the running notification, next to the 'Cancel' button.
There are three possible substitutions of the text in the title or body of a TaskNotification:
- {filename} is replaced with the filename as defined in the
Task - {progress} is substituted by a progress percentage, or '--%' if progress is unknown
- {metadata} is substituted by the
Task.metaDatafield
Notifications on iOS follow Apple's guidelines, notably:
- No progress bar is shown, and the {progress} substitution always substitutes to an empty string. In other words: only a single
runningnotification is shown and it is not updated until the download state changes - When the app is in the foreground, on iOS 14 and above the notification will not be shown but will appear in the NotificationCenter. On older iOS versions the notification will be shown also in the foreground. Apple suggests showing progress and download controls within the app when it is in the foreground
While notifications are possible on desktop platforms, there is no true background mode, and progress updates and indicators can be shown within the app. Notifications are therefore ignored on desktop platforms.
The configureNotification call configures notification behavior for all download tasks. You can specify a separate configuration for a group of tasks by calling configureNotificationForGroup and for a single task by calling configureNotificationForTask. A Task configuration overrides a group configuration, which overrides the default configuration.
When attempting to show its first notification, the downloader will ask the user for permission to show notifications (platform version dependent) and abide by the user choice. For Android, starting with API 33, you need to add <uses-permission android:name="android.permission.POST_NOTIFICATIONS" /> to your app's AndroidManifest.xml. Also on Android you can localize the button text by overriding string resources bg_downloader_cancel, bg_downloader_pause, bg_downloader_resume and descriptions bg_downloader_notification_channel_name, bg_downloader_notification_channel_description. Localization on iOS is not currently supported.
On iOS, add the following to your AppDelegate.swift:
UNUserNotificationCenter.current().delegate = self as UNUserNotificationCenterDelegate
or if using Objective C, add to AppDelegate.m:
[UNUserNotificationCenter currentNotificationCenter].delegate = (id<UNUserNotificationCenterDelegate>) self;
The download directories specified in the BaseDirectory enum are all local to the app. To make downloaded files available to the user outside of the app, or to other apps, they need to be moved to shared or scoped storage, and this is platform dependent behavior. For example, to move the downloaded file associated with a DownloadTask to a shared 'Downloads' storage destination, execute the following after the download has completed:
final newFilepath = await FileDownloader().moveToSharedStorage(task, SharedStorage.downloads);
if (newFilePath == null) {
... // handle error
} else {
... // do something with the newFilePath
}
Because the behavior is very platform-specific, not all SharedStorage destinations have the same result. The options are:
.downloads- implemented on all platforms, but on iOS files in this directory are not accessible to other users.images- implemented on Android and iOS only. On iOS files in this directory are not accessible to other users.video- implemented on Android and iOS only. On iOS files in this directory are not accessible to other users.audio- implemented on Android and iOS only. On iOS files in this directory are not accessible to other users.files- implemented on Android only.external- implemented on Android only
On MacOS, for the .downloads to work you need to enable App Sandbox entitlements and set the key com.apple.security.files.downloads.read-write to true.
On Android, depending on what SharedStorage destination you move a file to, and depending on the OS version your app runs on, you may require extra permissions WRITE_EXTERNAL_STORAGE and/or READ_EXTERNAL_STORAGE . See here for details on the new scoped storage rules starting with Android API version 30, which is what the plugin is using.
Methods moveToSharedStorage and the similar moveFileToSharedStorage also take an optional
directory argument for a subdirectory in the SharedStorage destination. They also take an
optional mimeType parameter that overrides the mimeType derived from the filePath extension.
Uploads are very similar to downloads, except:
- define an
UploadTaskobject instead of aDownloadTask - the file location now refers to the file you want to upload
- call
uploadinstead ofdownload, oruploadBatchinstead ofdownloadBatch
There are two ways to upload a file to a server: binary upload (where the file is included in the POST body) and form/multi-part upload. Which type of upload is appropriate depends on the server you are uploading to. The upload will be done using the binary upload method only if you have set the post field of the UploadTask to 'binary'.
For multi-part uploads you can specify name/value pairs in the fields field of the UploadTask as a Map<String, String>. These will be uploaded as form fields along with the file. You can also set the field name used for the file itself by setting fileField (default is "file") and override the mimeType by setting mimeType (default is derived from filename extension).
To enable pausing, set the allowPause field of the Task to true. This may also cause the task to pause un-commanded. For example, the OS may choose to pause the task if someone walks out of WiFi coverage.
To cancel, pause or resume a task, call:
cancelTaskWithIdto cancel the tasks with that taskIdcancelTasksWithIdsto cancel all tasks with ataskIdin the provided list of taskIdspauseto attempt to pause a task. Pausing is only possible for download GET requests, only if theTask.allowPausefield is true, and only if the server supports pause/resume. Soon after the task is running (TaskStatus.running) you can calltaskCanResumewhich will return a Future that resolves totrueif the server appears capable of pause & resume. If it is not, thenpausewill have no effect and return falseresumeto resume a previously paused task, which returns true if resume appears feasible. The taskStatus will follow the same sequence as a newly enqueued task. If resuming turns out to be not feasible (e.g. the operating system deleted the temp file with the partial download) then the task will either restart as a normal download, or fail.
To manage or query the queue of waiting or running tasks, call:
resetto reset the downloader, which cancels all ongoing download tasksallTaskIdsto get a list oftaskIdvalues of all tasks currently active (i.e. not in a final state). You can exclude tasks waiting for retries by settingincludeTasksWaitingToRetrytofalse. Note that paused tasks are not included in this listallTasksto get a list of all tasks currently active (i.e. not in a final state). You can exclude tasks waiting for retries by settingincludeTasksWaitingToRetrytofalse. Note that paused tasks are not included in this listtaskForIdto get theDownloadTaskfor the giventaskId, ornullif not found. Only tasks that are active (ie. not in a final state) are guaranteed to be returned, but returning a task does not guarantee that it is active
Because an app may require different types of downloads, and handle those differently, you can specify a group with your task, and register callbacks specific to each group. If no group is specified the default group named default is used. For example, to create and handle downloads for group 'bigFiles':
FileDownloader().registerCallbacks(
group: 'bigFiles'
taskStatusCallback: bigFilesDownloadStatusCallback,
taskProgressCallback: bigFilesDownloadProgressCallback);
final task = DownloadTask(
group: 'bigFiles',
url: 'https://google.com',
filename: 'google.html',
updates:
Updates.statusAndProgress);
final successFullyEnqueued = await FileDownloader().enqueue(task);
The methods registerCallBacks, reset, allTaskIds and allTasks all take an optional group parameter to target tasks in a specific group. Note that if tasks are enqueued with a group other than default, calling any of these methods without a group parameter will not affect/include those tasks - only the default tasks.
If you listen to the updates stream instead of using callbacks, you can test for the task's group field in your listener, and process the update differently for different groups.
Note: tasks that are started using download, upload, batchDownload or batchUpload are assigned a special group name 'await', as callbacks for these tasks are handled within the FileDownloader.
To make a regular server request (e.g. to obtain a response from an API end point that you process directly in your app) use the request method. It works similar to the download method, except you pass a Request object that has fewer fields than the DownloadTask, but is similar in structure. You await the response, which will be a Response object as defined in the dart http package, and includes getters for the response body (as a String or as UInt8List), statusCode and reasonPhrase.
Because requests are meant to be immediate, they are not enqueued like a Task is, and do not allow for status/progress monitoring.
The DownloadTask, UploadTask and Request objects all take several optional parameters that define how the task will be executed. Note that a Task is a subclass of Request, and both DownloadTask and UploadTask are subclasses of Task, so what applies to a Request or Task will also apply to a DownloadTask and UploadTask.
If provided, these parameters (presented as a Map<String, String>) will be appended to the url as query parameters. Note that both the url and urlQueryParameters must be urlEncoded (e.g. a space must be encoded as %20).
Optionally, headers can be added to the Task, which will be added to the HTTP request. This may be useful for authentication, for example.
For downloads, if the required server request is a HTTP POST request (instead of the default GET request) then set the post field of a DownloadTask to a String or UInt8List representing the data to be posted (for example, a JSON representation of an object). To make a POST request with no data, set post to an empty String.
For an UploadTask the POST field is used to request a binary upload, by setting it to 'binary'. By default, uploads are done using the form/multi-part format.
To schedule automatic retries of failed requests/tasks (with exponential backoff), set the retries field to an
integer between 1 and 10. A normal Task (without the need for retries) will follow status
updates from enqueued -> running -> complete (or notFound). If retries has been set and
the task fails, the sequence will be enqueued -> running ->
waitingToRetry -> enqueued -> running -> complete (if the second try succeeds, or more
retries if needed). A Request will behave similarly, except it does not provide intermediate status updates.
If the requiresWiFi field of a Task is set to true, the task won't start unless a WiFi network is available. By default requiresWiFi is false, and downloads/uploads will use the cellular (or metered) network if WiFi is not available, which may incur cost.
metaData can be added to a Task. It is ignored by the downloader but may be helpful when receiving an update about the task.
Set fileField to the field name the server expects for the file portion of a multi-part upload. Defaults to "file".
Set mimeType to the MIME type of the file to be uploaded. By default the MIME type is derived from the filename extension, e.g. a .txt file has MIME type text/plain.
Set fields to a Map<String, String> of name/value pairs to upload as "form fields" along with the file.
No setup is required for Windows or Linux.
No setup is required if you don't use notifications. If you do:
- Starting with API 33, you need to add
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />to your app'sAndroidManifest.xml - If needed, localize the button text by overriding string resources
bg_downloader_cancel,bg_downloader_pause,bg_downloader_resumeand descriptionsbg_downloader_notification_channel_name,bg_downloader_notification_channel_description.
On iOS, ensure that you have the Background Fetch capability enabled:
- Select the Runner target in XCode
- Select the Signing & Capabilities tab
- Click the + icon to add capabilities
- Select 'Background Modes'
- Tick the 'Background Fetch' mode
Note that iOS by default requires all URLs to be https (and not http). See here for more details and how to address issues.
If using notifications, add the following to your AppDelegate.swift:
UNUserNotificationCenter.current().delegate = self as UNUserNotificationCenterDelegate
or if using Objective C, add to AppDelegate.m:
[UNUserNotificationCenter currentNotificationCenter].delegate = (id<UNUserNotificationCenterDelegate>) self;
MacOS needs you to request a specific entitlement in order to access the network. To do that open macos/Runner/DebugProfile.entitlements and add the following key-value pair.
<key>com.apple.security.network.client</key>
<true/>
Then do the same thing in macos/Runner/Release.entitlements.
- On Android, downloads are by default limited to 9 minutes, after which the download will end with
TaskStatus.failed. To allow for longer downloads, set theDownloadTask.allowPausefield to true: if the task times out, it will pause and automatically resume, eventually downloading the entire file. - On iOS, once enqueued (i.e.
TaskStatus.enqueued), a background download must complete within 4 hours - Redirects will be followed
- Background downloads and uploads are aggressively controlled by the native platform. You should therefore always assume that a task that was started may not complete, and may disappear without providing any status or progress update to indicate why. For example, if a user swipes your app up from the iOS App Switcher, all scheduled background downloads are terminated without notification