Skip to main content

API-Reference

Interfaces

InterfaceDescription
DocutainSDKPluginMain class of the Docutain SDK.
InitSDKOptionsInitializes the Docutain SDK.
PageEditConfigurationA configuration class used to alter the default page editing behaviour.
DocutainColorA configuration class used to define color in light and dark mode
ColorConfigA configuration class used to alter the default color theming behaviour.
TextConfigurationA configuration class used to alter the default text behaviour.
DocutainButtonA generic button element used for the ready to use UI elements.
DocutainListItemA generic list element used for the ready to use UI elements.
OnboardingUI components that can be used to onboard the user.
ScanHintPopupA customizable popup within the scan screen which shows a short explanation about how to scan. It is displayed only once, when the scan screen is opened for the first time. Use [Onboarding.reset] to show it again.
ScanTipsUI components that can be used to provide the user some scan tips.
ButtonConfigurationA configuration class used to alter the default buttons.
StartDocumentScannerOptionsA configuration class used to alter the default scan behaviour.
ScanDocumentResult-
OnboardingDefaultItemsResult-
ScanTipsDefaultItemsResult-
EmptyResultScreenDefaultItemsResult-
LoadFileOptions-
GetTextPageOptions-
GetTextResult-
GetTextPageResult-
AnalyzeConfigurationOptions-
AnalyzeResult-
WritePDFOptions-
WritePDFResult-
SetLogLevelOptions-
GetTraceFileResult-
DeleteTempFilesOptions-
WriteImageOptions-
WriteImageResult-
GetImageBytesOptions-
GetImageBytesResult-
PageCountResult-
ResetOnboardingOptions-
PaymentAnalyzeConfigurationA configuration class used to alter the default document analysis behaviour for payment.
EmptyResultScreen-
StartPhotoPaymentOptionsA configuration class used to alter the default photo payment behaviour.
StartPhotoPaymentResult-
AnalyzeConfiguration-

Enumerations

EnumerationDescription
PDFPageFormatAvailable PDF page formats when generating PDF documents.
ScanFilterAvailable filters that can be applied on scanned documents.
PageSourceTypeAvailable page source types when generating image files from scanned or imported pages.
LogLevelAvailable log level for defining the level of logging detail
SourceAvailable sources for the document scanner.
StatusBarAppearanceAvailable statusbar appearances.
NavigationBarAppearanceAvailable navigationbar appearances.

Type Aliases

Type aliasDescription
DocumentScannerConfiguration-

Variables

VariableDescription
DocutainSDKDocutainSDK instance.