Skip to main content

Migration

Version 6.0.0 - May 07, 2025

Onboarding

With the new comprehensive onboarding functionality, the customizing of the previous onboarding popup within the scan screen has been moved to the new scanHintPopup class.

Therefore, the following properties have been deprecated and will be removed in a future version. If you are currently using at least one of them, we recommend to migrate to the new onboarding functionality as early as possible, to avoid breaking changes in the future.

DocumentScannerConfiguration

PropertyTypeDefault ValueDescription
onboardingImageSourcestringnullYour custom image for the onboarding dialog that appears when scan is opened for the first time.

TextConfiguration

PropertyTypeDescription
textOnboardingTitlestringThe text to show in the onboarding popup title that appears when the scan page is opened for the first time.
textOnboardingMessagestringThe text to show in the onboarding popup message that appears when the scan page is opened for the first time.
textOnboardingCloseButtonstringThe text to show in the onboarding popup close button that appears when the scan page is opened for the first time.
textSizeOnboardingTitlenumberThe text size of the onboarding popup title that appears when the scan page is opened for the first time.
textSizeOnboardingMessagenumberThe text size of the onboarding popup message that appears when the scan page is opened for the first time.

Document Scan

scanDocument and DocumentScannerConfiguration have been deprecated in favour of the new startDocumentScanner method. See Document Scan for more details. We recommend to migrate to the new method as early as possible, to avoid breaking changes in the future.

Analyze Configuration

setAnalyzeConfiguration and AnalyzeConfiguration have been deprecated in favour of the new setAnalyzeConfigurationDocScan method. See Data Extraction for more details. We recommend to migrate to the new method as early as possible, to avoid breaking changes in the future.