dockware-core/ai.dockware.scan.dockware_core/Dockware

Dockware

class Dockware : DockwareSdk

Types

CaptureActivitiesSession

interface CaptureActivitiesSession : Dockware.DocumentCaptureSession, Dockware.ObjectCaptureSession

object Companion

data class Dimensions(val width: Float? = null, val length: Float? = null, val height: Float? = null)

DocumentCaptureSession

interface DocumentCaptureSession

ObjectCaptureSession

interface ObjectCaptureSession

ScanCaptureData

sealed interface ScanCaptureData

sealed interface UploadStatus

Properties

open override val organization: OrganizationRepository

Repository for accessing organization-level data and settings.

open override val profile: ProfileRepository

Repository for managing the current user's profile and authentication status.

open override val settings: SettingsRepository

Repository for managing device-specific configurations and API versions.

open override val shipments: ShipmentsRepository

The main repository for shipment management, scan history, and sharing.

Functions

open override fun <T : Any> getPlugin(key: String): T?

Lazily fetches the plugin instance from the graph only when called.

startCaptureActivities

open override fun startCaptureActivities(context: Context, collectProcessedResults: Boolean): Dockware.CaptureActivitiesSession

A combined workflow that launches Document Capture first, followed immediately by Object Capture.

startDocumentCaptureActivity

open override fun startDocumentCaptureActivity(context: Context): Dockware.DocumentCaptureSession

Launches the UI for capturing document images (e.g., Pick Tickets).

startObjectCaptureActivity

open override fun startObjectCaptureActivity(context: Context, collectProcessedResults: Boolean): Dockware.ObjectCaptureSession

Launches the UI for 3D object dimensioning and scanning.