dockware-core/ai.dockware.core/Dockware

Dockware

The primary entry point for the Dockware SDK.

Use Dockware.builder to configure and build an instance. Once initialized, access the SDK features via Dockware.instance.

Types

Builder

interface Builder

CaptureActivitiesLauncher

class CaptureActivitiesLauncher

CaptureActivitiesSession

interface CaptureActivitiesSession : Dockware.DocumentCaptureSession, Dockware.ObjectCaptureSession

Companion

object Companion

DependencyGraph

interface DependencyGraph

DocumentCapture

sealed interface DocumentCapture

DocumentCaptureConfig

interface DocumentCaptureConfig

DocumentCaptureLauncher

class DocumentCaptureLauncher : Dockware.DocumentCaptureConfig

DocumentCaptureSession

interface DocumentCaptureSession

Image

interface Image

ManualDimensionsConfig

class ManualDimensionsConfig

ObjectCapture

sealed interface ObjectCapture

ObjectCaptureConfig

interface ObjectCaptureConfig

ObjectCaptureLauncher

class ObjectCaptureLauncher : Dockware.ObjectCaptureConfig

ObjectCaptureSession

interface ObjectCaptureSession

Properties

about

abstract val about: AboutRepository

Repository for general information about the dockware SDK, including NTEP certification data.

documents

abstract val documents: DocumentsRepository

Repository for managing documents.

organization

abstract val organization: OrganizationRepository

Repository for accessing organization-level data and settings.

profile

abstract val profile: ProfileRepository

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

settings

abstract val settings: SettingsRepository

Repository for managing device-specific configurations and API versions.

shipments

abstract val shipments: ShipmentsRepository

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

uploadService

abstract val uploadService: ShipmentUploadService

Repository for managing shipment uploads.

Functions

getPlugin

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

Retrieves a registered plugin instance.

promptManualDimensionsForShipmentScan

abstract fun promptManualDimensionsForShipmentScan(context: Context, scanId: String, configure: Dockware.ManualDimensionsConfig.() -> Unit = {})

startCaptureActivities

abstract fun startCaptureActivities(context: Context, configure: Dockware.CaptureActivitiesLauncher.() -> Unit = {}): Dockware.CaptureActivitiesSession

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

startDocumentCaptureActivity

abstract fun startDocumentCaptureActivity(context: Context, configure: Dockware.DocumentCaptureLauncher.() -> Unit = {}): Dockware.DocumentCaptureSession

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

startObjectCaptureActivity

abstract fun startObjectCaptureActivity(context: Context, configure: Dockware.ObjectCaptureLauncher.() -> Unit = {}): Dockware.ObjectCaptureSession

Launches the UI for 3D object dimensioning and scanning.