DownloadTask class final
Information related to a download task
An equality test on a DownloadTask is a test on the taskId only - all other fields are ignored in that test
- Inheritance
- Implementers
Constructors
-
DownloadTask({String? taskId, required String url, Map<
String, String> ? urlQueryParameters, String? filename, Map<String, String> headers = const {}, String? httpRequestMethod, dynamic post, String directory = '', BaseDirectory baseDirectory = BaseDirectory.applicationDocuments, String group = 'default', Updates updates = Updates.status, bool requiresWiFi = false, int retries = 0, bool allowPause = false, int priority = 5, String metaData = '', String displayName = '', DateTime? creationTime}) - Creates a DownloadTask
-
DownloadTask.fromJson(Map<
String, dynamic> json) -
Creates DownloadTask object from
json
Properties
- allowPause → bool
-
If true, task will pause if the task fails partly through the execution,
when some but not all bytes have transferred, provided the server supports
partial transfers. Such failures are typically temporary, eg due to
connectivity issues, and may be resumed when connectivity returns.
If false, task fails on any issue, and task cannot be paused
finalinherited
- baseDirectory → BaseDirectory
-
Base directory
finalinherited
- creationTime → DateTime
-
Time at which this request was first created
finalinherited
- directory → String
-
Optional directory, relative to the base directory
finalinherited
- displayName → String
-
Human readable name for this task - use {displayName} in notification
finalinherited
- filename → String
-
Filename of the file to store - use {filename} in notification
finalinherited
- group → String
-
Group that this task belongs to
finalinherited
- hasFilename → bool
-
True if this task has a filename, or false if set to
suggestno setter - hashCode → int
-
The hash code for this object.
no setterinherited
-
headers
→ Map<
String, String> -
potential additional headers to send with the request
finalinherited
- hostName → String
-
Hostname represented by the url. Throws FormatException if url cannot
be parsed, and returns empty string if no host in url
no setterinherited
- httpRequestMethod → String
-
HTTP request method to use
finalinherited
- metaData → String
-
User-defined metadata - use {metaData} in notification
finalinherited
- post → String?
-
Set post to make the request using POST instead of GET.
In the constructor, post must be one of the following:
finalinherited
- priority → int
-
Priority of this task, relative to other tasks.
Range 0 <= priority <= 10 with 0 being the highest priority.
Not all platforms will have the same actual granularity, and how
priority is considered is inconsistent across platforms.
finalinherited
- providesProgressUpdates → bool
-
If true, task expects progress updates
no setterinherited
- providesStatusUpdates → bool
-
If true, task expects status updates
no setterinherited
- requiresWiFi → bool
-
If true, will not download over cellular (metered) network
finalinherited
- retries → int
-
Maximum number of retries the downloader should attempt
finalinherited
- retriesRemaining ↔ int
-
Number of retries remaining
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- taskId → String
-
Identifier for the task - auto generated if omitted
finalinherited
- taskType → String
-
Returns the type of task as a String
no setteroverride
- updates → Updates
-
Type of progress updates desired
finalinherited
- url → String
-
String representation of the url, urlEncoded
finalinherited
-
validHttpMethods
→ List<
String> -
finalinherited
Methods
-
compareTo(
dynamic other) → int -
Returns this.priority - other.priority if not the same
Returns this.creationTime - other.creationTime if priorities the same
Returns 0 if other is not a Task
inherited
-
copyWith(
{String? taskId, String? url, String? filename, Map< String, String> ? headers, String? httpRequestMethod, Object? post, String? directory, BaseDirectory? baseDirectory, String? group, Updates? updates, bool? requiresWiFi, int? retries, int? retriesRemaining, bool? allowPause, int? priority, String? metaData, String? displayName, DateTime? creationTime}) → DownloadTask -
Returns a copy of the Task with optional changes to specific fields
override
-
decreaseRetriesRemaining(
) → void -
Decrease retriesRemaining by one
inherited
-
expectedFileSize(
) → Future< int> - Return the expected file size for this task, or -1 if unknown
-
filePath(
{String? withFilename}) → Future< String> -
Returns the absolute path to the file represented by this task
based on the
Task.filename(default) orwithFilenameinherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Creates JSON map of this object
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
withSuggestedFilename(
{dynamic unique = false, Future< DownloadTask> taskWithFilenameBuilder(DownloadTask task, Map<String, String> headers, bool unique) = taskWithSuggestedFilename}) → Future<DownloadTask> -
Returns a copy of the task with the
Task.filenameproperty changed to the filename suggested by the server, or derived from the url, or unchanged.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- suggestedFilename → const String
-
Constant used with
filenamefield to indicate server suggestion requested