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

DockwareSdk

interface DockwareSdk

The primary entry point for the Dockware SDK.

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

Inheritors

Properties

Link copied to clipboard
abstract val organization: OrganizationRepository

Repository for accessing organization-level data and settings.

Link copied to clipboard
abstract val profile: ProfileRepository

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

Link copied to clipboard
abstract val settings: SettingsRepository

Repository for managing device-specific configurations and API versions.

Link copied to clipboard
abstract val shipments: ShipmentsRepository

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

Functions

Link copied to clipboard
abstract fun <T : Any> getPlugin(key: String): T?

Retrieves a registered plugin instance.

Link copied to clipboard
abstract fun startCaptureActivities(context: Context, collectProcessedResults: Boolean): Dockware.CaptureActivitiesSession

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

Link copied to clipboard
abstract fun startDocumentCaptureActivity(context: Context): Dockware.DocumentCaptureSession

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

Link copied to clipboard
abstract fun startObjectCaptureActivity(context: Context, collectProcessedResults: Boolean): Dockware.ObjectCaptureSession

Launches the UI for 3D object dimensioning and scanning.

Generated by Dokka
© 2026 Copyright