Class DownloadPreplannedOfflineMapJob
- All Implemented Interfaces:
JsonSerializable
,RemoteResource
Use this job to download the map content of a map area to your device so that you can work offline without a network
connection. Upon completion, the job's DownloadPreplannedOfflineMapResult
provides the offline map along with
the details of any errors that occurred during the download process.
A DownloadPreplannedOfflineMapJob instance is returned by
OfflineMapTask.downloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String)
. The Job is
returned in a Status.NOT_STARTED
state and
Job.start()
must be called to start the associated operation.
See the Job
class for full information on how to work with jobs.
- Since:
- 100.2.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.esri.arcgisruntime.concurrent.Job
Job.Message, Job.MessageSeverity, Job.MessageSource, Job.Status
-
Field Summary
Fields inherited from class com.esri.arcgisruntime.concurrent.Job
mCredential, mRequestConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionGets the download directory path used by this job.Gets the online map used by this job.Gets the preplanned parameters used to create this job.Returns a DownloadPreplannedOfflineMapResult once the job has completed.Methods inherited from class com.esri.arcgisruntime.concurrent.Job
addJobDoneListener, addJobMessageAddedListener, addProgressChangedListener, addStatusChangedListener, cancelAsync, fromJson, getCredential, getError, getMessages, getProgress, getRequestConfiguration, getServerJobId, getStatus, getUnknownJson, getUnsupportedJson, getUri, pause, removeJobDoneListener, removeJobMessageAddedListener, removeProgressChangedListener, removeStatusChangedListener, setCredential, setRequestConfiguration, start, toJson
-
Method Details
-
getDownloadDirectoryPath
Gets the download directory path used by this job. This is the folder in which the resultant mobile map package is stored.The directory path is the path that was supplied as a parameter to the
OfflineMapTask.downloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String)
. The job will fail if the last directory in the path cannot be created or is not empty.- Returns:
- the directory path to the location of the mobile map package
- Since:
- 100.2.0
-
getOnlineMap
Gets the online map used by this job.- Returns:
- the online map used by this job
- Since:
- 100.2.0
-
getParameters
Gets the preplanned parameters used to create this job.- Returns:
- the preplanned map parameters used to create this job
- Since:
- 100.4.0
-
getResult
Returns a DownloadPreplannedOfflineMapResult once the job has completed. The methods of DownloadPreplannedOfflineMapResult indicate if there were errors related to any layers or tables within the map.
-