Skip to content

Migration Guide: From 6.x To 7.x

From v6.9 To v7.1

Changed event names:

  • completionEventcompletion
  • prepareDatabaseProgressChangeEventdatabase_progress
  • rfidNotificationCompletionEventrfidOnProgressCompletion

DocumentReader.startRFIDReader() and DocumentReader.readRFID() now accept 3 boolean variables:

  • doRequestPACertificates
  • doRequestTACertificates
  • doRequestTASignature

In most cases these parameters will have the false value.

DocumentReader.startRFIDReader(_ => { }, _ => { })
DocumentReader.startRFIDReader(false, false, false, _ => { }, _ => { })

DocumentReader.setConfig() is now divided into 3 functions:

DocumentReader.setConfig({
  functionality: {
    videoCaptureMotionControl: true,
    showCaptureButton: true
  },
  customization: {
    showResultStatusMessages: true,
    showStatusMessages: true
  },
  processParams: {
    logs: true
  },
}, _ => { }, _ => { })
DocumentReader.setFunctionality({
  videoCaptureMotionControl: true,
  showCaptureButton: true
}, _ => { }, _ => { })

DocumentReader.setCustomization({
  showResultStatusMessages: true,
  showStatusMessages: true
}, _ => { }, _ => { })

DocumentReader.setProcessParams({
  logs: true
}, _ => { }, _ => { })

The callbacks for synchronous functions without return value have been disabled, as they don't return anything.

See the full list of functions with disabled successCallback:

setTag
setFunctionality
setProcessParams
setCustomization
setRfidScenario
resetConfiguration
scan
recognize
startRFIDReader
readRFID
startBluetoothService
setLocalizationDictionary

Due to the current architecture design, you still need to pass a callback as a function parameter, but use the empty one _ => { } as it will never be executed. See the comparative example below.

DocumentReader.setLocalizationDictionary(dictionary, result => {
  console.log("Localization dictionary applied!")
}, error => { })
DocumentReader.setLocalizationDictionary(dictionary, _ => { }, _ => { })
console.log("Localization dictionary applied!")