-
public interface DockwareThe 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceDockware.Builderpublic interfaceDockware.DependencyGraphpublic interfaceDockware.UploadStatuspublic interfaceDockware.Imagepublic interfaceDockware.DocumentCapturepublic interfaceDockware.ObjectCapturepublic interfaceDockware.DocumentCaptureConfigpublic interfaceDockware.ObjectCaptureConfigpublic final classDockware.DocumentCaptureLauncherpublic final classDockware.ObjectCaptureLauncherpublic final classDockware.CaptureActivitiesLauncherpublic interfaceDockware.DocumentCaptureSessionpublic interfaceDockware.ObjectCaptureSessionpublic interfaceDockware.CaptureActivitiesSessionpublic classDockware.Companion
-
Method Summary
Modifier and Type Method Description abstract <T extends Any> TgetPlugin(String key)Retrieves a registered plugin instance. abstract Dockware.DocumentCaptureSessionstartDocumentCaptureActivity(Context context, Function1<Dockware.DocumentCaptureLauncher, Unit> configure)Launches the UI for capturing document images (e.g., Pick Tickets). abstract Dockware.ObjectCaptureSessionstartObjectCaptureActivity(Context context, Function1<Dockware.ObjectCaptureLauncher, Unit> configure)Launches the UI for 3D object dimensioning and scanning. abstract Dockware.CaptureActivitiesSessionstartCaptureActivities(Context context, Function1<Dockware.CaptureActivitiesLauncher, Unit> configure)A combined workflow that launches Document Capture first, followed immediately by Object Capture. abstract SettingsRepositorygetSettings()Repository for managing device-specific configurations and API versions. abstract ProfileRepositorygetProfile()Repository for managing the current user's profile and authentication status. abstract OrganizationRepositorygetOrganization()Repository for accessing organization-level data and settings. abstract ShipmentsRepositorygetShipments()The main repository for shipment management, scan history, and sharing. abstract DocumentsRepositorygetDocuments()Repository for managing documents. abstract ShipmentUploadServicegetUploadService()Repository for managing shipment uploads. -
-
Method Detail
-
getPlugin
abstract <T extends Any> T getPlugin(String key)
Retrieves a registered plugin instance.
- Parameters:
key- The unique key provided during plugin registration.
-
startDocumentCaptureActivity
abstract Dockware.DocumentCaptureSession startDocumentCaptureActivity(Context context, Function1<Dockware.DocumentCaptureLauncher, Unit> configure)
Launches the UI for capturing document images (e.g., Pick Tickets).
- Parameters:
context- The Android Context used to start the DocumentCaptureActivity.
-
startObjectCaptureActivity
abstract Dockware.ObjectCaptureSession startObjectCaptureActivity(Context context, Function1<Dockware.ObjectCaptureLauncher, Unit> configure)
Launches the UI for 3D object dimensioning and scanning.
- Parameters:
context- The Android Context used to start the ScanActivity.
-
startCaptureActivities
abstract Dockware.CaptureActivitiesSession startCaptureActivities(Context context, Function1<Dockware.CaptureActivitiesLauncher, Unit> configure)
A combined workflow that launches Document Capture first, followed immediately by Object Capture.
-
getSettings
abstract SettingsRepository getSettings()
Repository for managing device-specific configurations and API versions.
-
getProfile
abstract ProfileRepository getProfile()
Repository for managing the current user's profile and authentication status.
-
getOrganization
abstract OrganizationRepository getOrganization()
Repository for accessing organization-level data and settings.
-
getShipments
abstract ShipmentsRepository getShipments()
The main repository for shipment management, scan history, and sharing.
-
getDocuments
abstract DocumentsRepository getDocuments()
Repository for managing documents.
-
getUploadService
abstract ShipmentUploadService getUploadService()
Repository for managing shipment uploads.
-
-
-
-