arcgis-maps-kotlin/com.arcgismaps.tasks.tilecache/EstimateTileCacheSizeJob

EstimateTileCacheSizeJob

class EstimateTileCacheSizeJob : Job<EstimateTileCacheSizeResult>

A job that estimates the size of a tile cache (.tpk or .tpkx) that can be exported from a map or image service. Use the EstimateTileCacheSizeJob to get the approximate size of a tile cache for a specific set of ExportTileCacheParameters. Note that time required to create a tile cache varies depending on the extent requested, the number of levels requested, the network connection speed, and so on. When planning a large offline data capture event, generate a smaller tile cache to get an idea of how long caching will take.

To make an EstimateTileCacheSizeJob, use the ExportTileCacheTask as follows:

Confirm that the map or image service can export tiles by checking com.arcgismaps.arcgisservices.ArcGISMapServiceInfo.exportTileCacheCompactV2Allowed for the compact version 2 format (.tpkx) and com.arcgismaps.arcgisservices.ArcGISMapServiceInfo.exportTilesAllowed for the legacy format (.tpk).
Construct and load the ExportTileCacheTask with the map or image service.
Create a com.arcgismaps.geometry.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 EstimateTileCacheSizeJob by calling ExportTileCacheTask.createEstimateTileCacheSizeJob.

Start the EstimateTileCacheSizeJob and monitor progress. Upon completion, the job's EstimateTileCacheSizeResult provides an estimate of the number and size of files in the tile cache.

See the com.arcgismaps.tasks.Job class for full information on how to work with jobs.

Since

200.1.0

Types

Companion

object Companion

Inherited properties

messages

open override val messages: SharedFlow<JobMessage>

The job's messages. Indicates that a new JobMessage was generated.

progress

open override val progress: StateFlow<Int>

The current progress of the job as a percentage complete. This emits updates when the progress value changes.

serverJobId

open override val serverJobId: String

The server job Id of the job.

status

open override val status: StateFlow<JobStatus>

The status of the job.

Inherited functions

cancel

open suspend override fun cancel(): Result<Boolean>

Cancels this Job and waits for any asynchronous, server-side operations to be canceled. The job is canceled and will result in a JobStatus.Failed status after all cancellation tasks have completed. For jobs running on a server, a cancel request is sent for the associated Job.serverJobId. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. Examples of server-side jobs include:

checkStatus

open suspend override fun checkStatus(): Result<Boolean>

Initiates a request to check the server status. If the job is polling the server for status and is in a time gap, then calling this method will ensure a request is sent right away. The result can be false if the job is not checking server status for example if the job status is paused or uploading.

pause

open override fun pause(): Boolean

Pauses the job.

result