Migration
Version 2.0.0 - May 22, 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
| Property | Type | Description |
|---|---|---|
onboardingImageSource | string | Your custom image for the onboarding dialog that appears when scan is opened for the first time. |
TextConfiguration
| Property | Type | Description |
|---|---|---|
textOnboardingTitle | string | The text to show in the onboarding popup title that appears when the scan page is opened for the first time. |
textOnboardingMessage | string | The text to show in the onboarding popup message that appears when the scan page is opened for the first time. |
textOnboardingCloseButton | string | The text to show in the onboarding popup close button that appears when the scan page is opened for the first time. |
textSizeOnboardingTitle | number | The text size of the onboarding popup title that appears when the scan page is opened for the first time. |
textSizeOnboardingMessage | number | The text size of the onboarding popup message that appears when the scan page is opened for the first time. |
Document Scan
The return type of DocutainSDK.scanDocument has been changed from boolean to void. If the user cancels the scan process, you
will get an error. See Document Scan for more details.