API-Reference

Interfaces

Interface	Description
DocutainSDKPlugin	Main class of the Docutain SDK.
InitSDKOptions	Options for initSDK.
PageEditConfiguration	A configuration class used to alter the default page editing behaviour.
DocutainColor	A configuration class used to define color in light and dark mode.
ColorConfig	A configuration class used to alter the default color theming behaviour.
TextConfiguration	A configuration class used to alter the default text behaviour.
DocutainButton	A generic button element used for the ready to use UI elements.
DocutainListItem	A generic list element used for the ready to use UI elements.
Onboarding	UI components that can be used to onboard the user.
ScanHintPopup	A popup within the scan screen which shows a short explanation about how to scan.
ScanTips	UI components that can be used to provide the user some scan tips.
ButtonConfiguration	A configuration class used to alter the default buttons.
StartDocumentScannerOptions	A configuration class used to alter the default scan behaviour.
ScanDocumentResult	The result of scanDocument.
OnboardingDefaultItemsResult	The result of onboardingDefaultItems.
ScanTipsDefaultItemsResult	The result of scanTipsDefaultItems.
EmptyResultScreenDefaultItemsResult	The result of emptyResultScreenDefaultItems.
LoadFileOptions	Options for loadFile.
GetTextPageOptions	Options for getTextPage.
GetTextResult	The result of getText.
GetTextPageResult	The result of getTextPage.
AnalyzeConfigurationOptions	Options for setAnalyzeConfigurationDocScan.
AnalyzeResult	The result of analyze.
WritePDFOptions	Options for writePDF.
WritePDFResult	The result of writePDF.
SetLogLevelOptions	Options for setLogLevel.
GetTraceFileResult	The result of getTraceFile.
DeleteTempFilesOptions	Options for deleteTempFiles.
WriteImageOptions	Options for writeImage.
WriteImageResult	The result of writeImage.
GetImageBytesOptions	Options for getImageBytes.
GetImageBytesResult	The result of getImageBytes.
PageCountResult	The result of pageCount.
ResetOnboardingOptions	Options for resetOnboarding.
PaymentAnalyzeConfiguration	A configuration class used to alter the default document analysis behaviour for payment.
EmptyResultScreen	A configuration class used to alter the default empty result screen.
StartPhotoPaymentOptions	A configuration class used to alter the default photo payment behaviour.
StartPhotoPaymentResult	The result of startPhotoPayment.
AnalyzeConfiguration	A configuration class used to alter the default document analysis behaviour.

Enumerations

Enumeration	Description
PDFPageFormat	Available PDF page formats when generating PDF documents.
ScanFilter	Available filters that can be applied on scanned documents.
PageSourceType	Available page source types when generating image files from scanned or imported pages.
LogLevel	Available log level for defining the level of logging detail
Source	Available sources for the document scanner.
StatusBarAppearance	Available statusbar appearances.
NavigationBarAppearance	Available navigationbar appearances.

Type Aliases

Type alias	Description
DocumentScannerConfiguration	A configuration class used to alter the default document scan behaviour.

Variables

Variable	Description
DocutainSDK	DocutainSDK instance.