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

EstimateTileCacheSizeJob

class EstimateTileCacheSizeJob : Job<EstimateTileCacheSizeResult>

A job that estimates the size of a tile cache from a service.

Since

200.1.0

See also

ExportTileCacheJob

Types

object Companion

Inherited properties

open override val messages: SharedFlow<JobMessage>

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

open override val progress: StateFlow<Int>

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

open override val serverJobId: String

The server job Id of the job.

open override val status: StateFlow<JobStatus>

The status of the job.

Inherited functions

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:

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.

open override fun pause(): Boolean

Pauses the job.

open suspend override fun result(): Result<EstimateTileCacheSizeResult>

Suspends until this job has completed. Calling this function does not start the job. In order to start the job call start

open override fun start(): Boolean

Starts executing the job if the job is not started or paused.

open override fun toJson(): String

Convert an object to JSON string.