ExportTileCacheJob class final
A job that exports a tile cache (.tpk or .tpkx) from a map or image service.
To make an ExportTileCacheJob, use the ExportTileCacheTask as follows:
- Confirm that the map or image service can export tiles by checking ArcGISMapServiceInfo.exportTilesAllowed for the legacy format and ArcGISMapServiceInfo.exportTileCacheCompactV2Allowed property for the compact version 2 format (.tpkx).
- Construct and load the ExportTileCacheTask with the map or image service.
- Create a Geometry to define the area of interest that you wish to take offline.
- Obtain the default ExportTileCacheParameters by calling ExportTileCacheTask.createDefaultExportTileCacheParameters with the area of interest and a minimum and maximum scale for the tile cache.
- Use the ExportTileCacheParameters to create an ExportTileCacheJob by calling ExportTileCacheTask.exportTileCache. You must specify a path to a folder where the tile cache will be stored on the device.
Start the ExportTileCacheJob and monitor progress. Upon completion, the job's result returns a tile cache.
See the Job class for full information on how to work with jobs.
Properties
- 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
-
onMessageAdded
→ Stream<
JobMessage> -
Indicates that a new
JobMessage
was 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
- progress → int
-
The current progress of the job as a percentage complete.
no setterinherited
- result → TileCache?
-
For a successfully completed job the result returns a tile cache.
Otherwise null is returned.
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< TileCache> -
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