search
HomeWebsiteGitHubGoogle Play

Migration Guide

This page contains guidance for migrating from one version to another

hashtag
Migrating from v5.0 to v5.1

circle-info

If you build an app with AndroidX, you have to enable the Jetifier plugin that automatically migrates existing third-party libraries to use AndroidX. See howarrow-up-right.

hashtag
Database

The database has to be updated along with the SDK as it's a part of it.

hashtag
Show scanner

If the below error was encountered, make sure that the right context had been passed to the showScanner() method, i.e. it has to be the context of the activity rather than the application.

Calling startActivity() from outside of an Activity context requires the FLAG_ACTIVITY_NEW_TASK flag. Is this really what you want?

hashtag
Custom settings

Custom settings of the Customization and Functionality class have to be set in the following way:

DocumentReader.Instance().customization().edit().setStatus("Hello").applyImmediately(MainActivity.this);
DocumentReader.Instance().customization().edit().setShowHelpAnimation(true).apply();

DocumentReader.Instance().functionality().edit().setShowCaptureButton(true).apply();
DocumentReader.Instance().functionality().edit().setVideoCaptureMotionControl(true).apply();

hashtag
Completion

DocumentReader.DocumentReaderCompletion was changed to IDocumentReaderCompletion.

DocumentReader.DocumentReaderInitCompletion was changed to IDocumentReaderInitCompletion.

DocumentReader.DocumentReaderPrepareCompletion was changed to IDocumentReaderPrepareCompletion.

hashtag
Migrating from v4.2 to v5.0

hashtag
Dependencies

Make sure that the new commonarrow-up-right library is added to the project and presented in the External Libraries list, otherwise, you may encounter the following errors:

hashtag
Custom settings

Custom settings should be declared in the following way:

hashtag
Document Type Result

documentType is an array now that contains information about each page that has been read.

hashtag
Text Result

Total text result status takes one of eCheckResult enum values instead of eRPRM_FieldVerificationResult.

hashtag
Graphic Result

GT_DOCUMENT_REAR was removed and GT_DOCUMENT_FRONT was renamed to GF_DOCUMENT_IMAGE (see eGraphicFieldType enum). In order to get the appropriate document side you should use the new property pageIndex, which is available in DocumentReaderGraphicResult class, e.g. pageIndex = 0 - it’s the first (front) side of the document, pageIndex = 1 - it’s the second (back) side of the document:

PreviousChangelogNextRequirements

Last updated