DownloadPreplannedOfflineMapJob class final
A job to download the offline map for an offline map area from a web map that is enabled for offline use and has offline map areas defined.
This job is part of the ahead-of-time offline workflow. Use this job to download the offline map to your device so that you can work offline without a network connection. Note that offline map areas may also be referred to as preplanned map areas.
To make a DownloadPreplannedOfflineMapJob, use the OfflineMapTask as follows:
- Construct and load the OfflineMapTask with a web map that is enabled for offline use. For more information about enabling web maps for offline use see Take web maps offline.
- If necessary, check the web map's offline capabilities by using OfflineMapTask.getOfflineMapCapabilities.
- Select an offline map area from the collection of offline map areas returned by OfflineMapTask.getPreplannedMapAreas.
- Obtain the default DownloadPreplannedOfflineMapParameters for the offline map area by calling OfflineMapTask.createDefaultDownloadPreplannedOfflineMapParameters.
- Adjust any parameters, as required.
- Use the DownloadPreplannedOfflineMapParameters to create a DownloadPreplannedOfflineMapJob by calling OfflineMapTask.downloadPreplannedOfflineMapWithParameters. You must specify a path to a folder where the map content will be stored on the device.
Start the DownloadPreplannedOfflineMapJob and monitor progress. Upon completion, the job's DownloadPreplannedOfflineMapResult provides the offline map along with the details of any errors incurred during the download process.
See the Job class for full information on how to work with jobs.
- Inheritance
-
- Object
- Job<
DownloadPreplannedOfflineMapResult> - DownloadPreplannedOfflineMapJob
Properties
- downloadDirectoryUri → Uri
-
The directory path to the location of the mobile map package.
no setter
- error → ArcGISException?
-
Contains an error if the job fails, otherwise null.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
messages
→ List<
JobMessage> -
The job's messages.
no setterinherited
-
onJobDone
→ Stream<
void> -
Sets the function that will be called when the job is done.
no setterinherited
- onlineMap → ArcGISMap?
-
The online map used by this job.
no setter
-
onMessageAdded
→ Stream<
JobMessage> -
Indicates that a new
JobMessagewas added to Job.messages.no setterinherited -
onProgressChanged
→ Stream<
int> -
Sets the function that will be called when the job's progress has changed.
no setterinherited
-
onStatusChanged
→ Stream<
JobStatus> -
Indicates that the Job.status property has changed.
no setterinherited
- parameters → DownloadPreplannedOfflineMapParameters
-
The preplanned map parameters used to create this job.
no setter
- progress → int
-
The current progress of the job as a percentage complete.
no setterinherited
- result → DownloadPreplannedOfflineMapResult?
-
The result of a download preplanned offline map job that has succeeded.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverJobId → String
-
The server job Id of the job.
no setterinherited
- status → JobStatus
-
The status of the job.
no setterinherited
Methods
-
cancel(
) → Future< bool> -
Cancels this Job and waits for any asynchronous, server-side operations
to be canceled.
inherited
-
checkStatus(
) → Future< bool> -
Initiates a request to check the server status.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → bool -
Pauses the job.
inherited
-
run(
) → Future< DownloadPreplannedOfflineMapResult> -
Starts the job and returns a Future that completes with either the result
of the job or an error if the job did not finish successfully.
inherited
-
start(
) → bool -
Starts the job if the job is not started or paused.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
-
toJsonString(
) → String -
Returns a JSON representation of this Object as a String.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited