Migration Guide: From 5.x To 6.x

From v6.8 To v6.9

• The readRFID and startRFIDReader methods in the DocumentReader class have changed their completion from IDocumentReaderCompletion to IRfidCompletion.

Without completion:

Java Kotlin

DocumentReader.Instance().startRFIDReader(this, new IRfidReaderCompletion() {
    @Override
    public void onCompleted(int action, @Nullable DocumentReaderResults results, @Nullable DocumentReaderException error) {
        ...
    }
});

DocumentReader.Instance().startRFIDReader(this@MainActivity, object : IRfidReaderCompletion() {
    override fun onCompleted(
        rfidAction: Int,
        documentReaderResults: DocumentReaderResults?,
        e: DocumentReaderException?
    ) {
        ...
    }
})

With completion:

Java Kotlin

DocumentReader.Instance().startRFIDReader(MainActivity.this, new IRfidReaderCompletion() {
    @Override
    public void onCompleted(int action, @Nullable DocumentReaderResults results, @Nullable DocumentReaderException error) {
        ...
    }

    @Override
    public void onChipDetected() {
        ...
    }

    @Override
    public void onRetryReadChip(@NonNull DocReaderRfidException exception) {
        ...
    }

    @Override
    public void onProgress(@NonNull DocumentReaderNotification notification) {
        ...
    }
});

DocumentReader.Instance().startRFIDReader(this@MainActivity, object : IRfidReaderCompletion() {
    override fun onCompleted(
        rfidAction: Int,
        documentReaderResults: DocumentReaderResults?,
        e: DocumentReaderException?
    ) {
        ...
    }

    override fun onChipDetected() {
        ...
    }

    override fun onProgress(notification: DocumentReaderNotification) {
        ...
    }

    override fun onRetryReadChip(exception: DocReaderRfidException) {
        ...
    }
})

• IRfidPKDCertificateCompletion, IRfidReaderRequest, IRfidTASignatureCompletion, and ITccParamsCompletion have changed their package name from com.regula.documentreader.api.completions to com.regula.documentreader.api.completions.rfid.

• The NOTIFICATION value in the DocReaderAction enum has been deprecated.

• The documentReaderNotification field in the DocumentReaderResults class has been deprecated. Use the onProgress method in IRfidReaderCompletion instead.

• Use ScannerConfig in the showScanner method:

Java Kotlin

ScannerConfig scannerConfig = new ScannerConfig.Builder(Scenario.SCENARIO_MRZ).build();
DocumentReader.Instance().showScanner(MainActivity.this, scannerConfig, completion);

val scannerConfig = ScannerConfig.Builder(Scenario.SCENARIO_MRZ).build()
DocumentReader.Instance().showScanner(this@MainActivity, scannerConfig, completion)

• The setOnlineProcessingConfiguration method has been deprecated in the Functionality class. Use OnlineProcessingConfig instead.

• The recognizeImage and recognizeImages methods have been deprecated. Use the recognize method with RecognizeConfig instead.

Java Kotlin

RecognizeConfig recognizeConfig = RecognizeConfig.Builder(Scenario.SCENARIO_MRZ).setBitmap(bitmap).build();
DocumentReader.Instance().recognize(recognizeConfig, completion);

val recognizeConfig = RecognizeConfig.Builder(Scenario.SCENARIO_MRZ).setBitmap(bitmap).build()
DocumentReader.Instance().recognize(recognizeConfig, completion)

• The getDefaultReadingBufferSize method in the RfidScenario class now returns 0 instead of 231.

• Values for the error codes in the DocumentReaderException class have been changed.

• The following values in the eRPRM_Authenticity enum have been renamed:

  • from RPRM_AUTHENTICITY_STATUS_ONLY to STATUS_ONLY
  • from RPRM_AUTHENTICITY_OVI to OVI
  • from RPRM_AUTHENTICITY_LIVENESS to LIVENESS
  • from RPRM_AUTHENTICITY_OCR to OCR

From v6.7 To v6.8

• Changed the constant value for MRZ_QUALITY_WRONG_MRZ_DPI to MRZ_QUALITY_WRONG_SYMBOL_POSITION. Updated the string associated with it to MRZ_QUALITY_WRONG_SYMBOL_POSITION.

• Added new constants to the eCheckDiagnose enumeration:

MRZ_QUALITY_WRONG_SYMBOL_POSITION = 200
MRZ_QUALITY_WRONG_MRZ_WIDTH = 202
MRZ_QUALITY_WRONG_MRZ_HEIGHT = 203
MRZ_QUALITY_WRONG_LINE_POSITION = 204
OCR_QUALITY_TEXT_POSITION = 220
OCR_QUALITY_INVALID_FONT = 221
OCR_QUALITY_INVALID_BACKGROUND = 222
LAS_INK_INVALID_LINES_FREQUENCY = 230

• Changed the value for LAST_DIAGNOSE_VALUE from 210 to 250.

From v6.5 To v6.6

• Deprecated the validity property in the DocumentReaderValue class, use DocumentReaderTextField#validityList instead.
• Deprecated the comparison property in the DocumentReaderValue class, use DocumentReaderTextField#comparisonList instead.
• Renamed the Device7310Config class to BleDeviceConfig.
• Added the @NonNull Context parameter to the Document Reader's cancelDBUpdate method.

From v6.3 To v6.4

• Added new action to the DocReaderAction enum - TIMEOUT. It means that if the processing is completed by timeout, this action will be called instead of COMPLETE.
• Changed value of the field dtRegistrationCertificate in the diDocType enum from 31 to 206.

From v6.2 To v6.3

• Replaced the original support library APIs to AndroidX.

From v6.1 To v6.2

• Removed eRFID_NotificationAndErrorCodes enum. Use eRFID_NotificationCodes or eRFID_ErrorCodes instead.

From v5.8 To v6.1

• Renamed DocumentReaderScenarioFull to CoreDetailedScenario.

• Deprecated the getOverallResult() method in DocumentReaderResults. Use the status field instead, see more details in DocumentReaderResultsStatus.

• Deprecated the RFIDSessionDataStatus class and the sessionDataStatus field in the RFIDSessionData class.

• The minimum API level supported — 21.