ShipmentUploadService

Types

data class BaseStatus(val stage: ShipmentUploadService.Stage, val message: String? = null, val shipmentId: String? = null, val scanId: String? = null) : ShipmentUploadService.Status

data class CurrentStatus(val queueId: String, val stage: ShipmentUploadService.Stage, val message: String? = null, val shipmentId: String? = null, val scanId: String? = null) : ShipmentUploadService.Status

data class DocumentStatus(val stage: ShipmentUploadService.Stage, val message: String? = null, val shipmentId: String? = null, val scanId: String? = null, val uploadJobId: String? = null) : ShipmentUploadService.Status

sealed class Queued

interface Stage

abstract class Status

A map that keys queue IDs to the status for the item. This includes completed queue items.

The status for the current queue item being uploaded.

The waiting queue of 3D objects or documents to be uploaded.

abstract fun clearQueue()

abstract fun queueDocumentUpload(imageData: ByteArray, type: ShipmentScanType.DocumentType = ShipmentScanType.DocumentType.DOCUMENT, shipmentId: String? = null): String

abstract fun queueObjectUpload(dimensions: Dimensions?, weight: Float?, freightClass: String?, locationData: LocationData?, barcodeData: List<BaseBarcode>, scannerFolderId: String, jsonMetadata: Map<String, String>, validationResult: SnapshotValidation, shipmentId: String? = null): String