dockware-core/ai.dockware.core/DockwareSdk

DockwareSdk

class DockwareSdk(koin: Koin, pluginRegistry: Map<String, KClass<*>>, ioDispatcher: CoroutineDispatcher = Dispatchers.IO) : Dockware, AndroidDockware

Constructors

DockwareSdk

constructor(koin: Koin, pluginRegistry: Map<String, KClass<*>>, ioDispatcher: CoroutineDispatcher = Dispatchers.IO)

Types

Builder

class Builder : Dockware.Builder, AndroidDockware.Builder

Companion

object Companion

Properties

about

open override val about: AboutRepository

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

documents

open override val documents: DocumentsRepository

Repository for managing documents.

organization

open override val organization: OrganizationRepository

Repository for accessing organization-level data and settings.

profile

open override val profile: ProfileRepository

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

settings

open override val settings: SettingsRepository

Repository for managing device-specific configurations and API versions.

shipments

open override val shipments: ShipmentsRepository

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

uploadService

open override val uploadService: ShipmentUploadService

Repository for managing shipment uploads.

Functions

getPlugin

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

Lazily fetches the plugin instance from Koin using the registered type.

promptManualDimensionsForShipmentScan

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

startActivityChain

open override fun startActivityChain(context: Context): ActivityChain

startCaptureActivities

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

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

startDocumentCaptureActivity

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

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

startObjectCaptureActivity

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

Launches the UI for 3D object dimensioning and scanning.

startPhotoCaptureActivity

open override fun startPhotoCaptureActivity(context: Context, configure: Dockware.PhotoCaptureLauncher.() -> Unit = {}): Dockware.DocumentCaptureSession

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