-
public interface ShipmentUploadService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceShipmentUploadService.Stagepublic abstract classShipmentUploadService.Statuspublic final classShipmentUploadService.BaseStatuspublic final classShipmentUploadService.CurrentStatuspublic final classShipmentUploadService.DocumentStatuspublic classShipmentUploadService.Queued
-
Method Summary
Modifier and Type Method Description abstract StringqueueObjectUpload(Dimensions dimensions, Float weight, String freightClass, LocationData locationData, List<BaseBarcode> barcodeData, String scannerFolderId, Map<String, String> jsonMetadata, SnapshotValidation validationResult, String shipmentId)abstract StringqueueDocumentUpload(ByteArray imageData, ShipmentScanType.DocumentType type, String shipmentId)abstract Result<Unit>removeQueueItem(String id)abstract UnitclearQueue()abstract StateFlow<List<ShipmentUploadService.Queued>>getQueue()The waiting queue of 3D objects or documents to be uploaded. abstract StateFlow<Map<String, ShipmentUploadService.Status>>getAllStatuses()A map that keys queue IDs to the status for the item. abstract StateFlow<ShipmentUploadService.CurrentStatus>getCurrentStatus()The status for the current queue item being uploaded. -
-
Method Detail
-
queueObjectUpload
abstract String queueObjectUpload(Dimensions dimensions, Float weight, String freightClass, LocationData locationData, List<BaseBarcode> barcodeData, String scannerFolderId, Map<String, String> jsonMetadata, SnapshotValidation validationResult, String shipmentId)
-
queueDocumentUpload
abstract String queueDocumentUpload(ByteArray imageData, ShipmentScanType.DocumentType type, String shipmentId)
-
removeQueueItem
abstract Result<Unit> removeQueueItem(String id)
-
clearQueue
abstract Unit clearQueue()
-
getQueue
abstract StateFlow<List<ShipmentUploadService.Queued>> getQueue()
The waiting queue of 3D objects or documents to be uploaded.
-
getAllStatuses
abstract StateFlow<Map<String, ShipmentUploadService.Status>> getAllStatuses()
A map that keys queue IDs to the status for the item. This includes completed queue items.
-
getCurrentStatus
abstract StateFlow<ShipmentUploadService.CurrentStatus> getCurrentStatus()
The status for the current queue item being uploaded.
-
-
-
-