eSCLKt/io.github.chrisimx.esclkt/ScanJob

ScanJob

class ScanJob(val jobUri: String, val esclClient: ESCLRequestClient, val scanSettings: ScanSettings)

Constructors

constructor(jobUri: String, esclClient: ESCLRequestClient, scanSettings: ScanSettings)

constructor(jobUrl: Url, esclClient: ESCLRequestClient, scanSettings: ScanSettings)

Properties

val esclClient: ESCLRequestClient

val jobUri: String

val scanSettings: ScanSettings

Functions

suspend fun cancle(): ESCLRequestClient.ScannerDeleteJobResult

Tries to cancle the scan job

suspend fun getJobStatus(): JobInfo?

Executes a ScannerStatus request to the scanner, finds the job in the ScannerStatus and returns the current job status as JobInfo

getScanImageInfoForRetrievedPage

suspend fun getScanImageInfoForRetrievedPage(): ESCLRequestClient.RetrieveScanImageInfoResult

Gets the ScanImageInfo for the last retrieved page

retrieveNextPage

suspend fun retrieveNextPage(): ESCLRequestClient.ScannerNextPageResult

Executes a NextPage request to the scanner to retrieve the next page of the scan job

open override fun toString(): String