Skip to main content

Migrate to Data Capture SDK 8.x

This guide will help you migrate from versions 7.x of the Scandit Smart Data Capture SDK to version 8.x.

Version 8.0 deprecates and removes many APIs from versions 7.x, as well as making many of the existing APIs more intuitive, resulting in a simpler and quicker integration experience.

While not all features and functionalities are impacted, it is likely you will need to modify your app. If you are unsure about how to perform the migration or the feature you are using is not covered in this migration guide, please reach out to our support team.

Updating for Deprecated APIs​

Version 5.x/6.x Users

If your app is still using version 5.x or 6.x of the Scandit Barcode Scanner SDK, you will need to first migrate to version 6.x and/or 7.x before migrating to version 8.x. Please refer to the migration guide from 5.x to 6.x and migration guide from 6.x to 7.x for more information.

Version 8.0 includes the removal of all APIs that were deprecated throughout the 7.x series. For the simplest migration process, we recommend you:

  • Update your app to the latest 7.6.x version. This version includes warnings for all deprecated APIs.
  • Address all deprecation warnings in your app.
  • Update to version 8.0.

Barcode Capture Changes​

Core​

In this release, VideoResolution::Auto has been now deprecated. Please use the respective capture mode's recommendedCameraSettings for the best results.

Smart Label Capture​

The properties of the LabelFieldDefinition API have been renamed to better reflect their purpose:

Old Property NameNew Property Name
patternvalueRegex
patternsvalueRegexes
dataTypePatternanchorRegex
dataTypePatternsanchorRegexes

SparkScan​

In version 7.0, we are introducing the second generation of our ready-to-use barcode scanning UI, SparkScan. This new UI is more intuitive and provides a more modern look and feel, as well as bringing more customization options.

As part of these changes, there have been various deprecations, modifications, and additions to the SparkScan APIs, as detailed below.

Building on the second generation of SparkScan, version 8.0 expands SparkScan beyond barcode scanning to include support for scanning any combination of barcodes and text present on a target. The feature is available in beta at the moment, please contact Scandit Support if you are interested in trying it out.

ID Capture Changes​

The ID Capture and Validation API was completely redesigned in version 7.0, and version 8.0 builds on those changes with the following improvements:

  • Added ElementsToRetain to MobileDocumentScanner: The set of data elements that the application intends to retain from scanned mobile documents. This information is used to set the IntentToRetain flag in ISO 18013-5 mdoc requests, which is required for legal compliance with data protection standards. An empty set indicates no elements will be retained, and IntentToRetain will be set to false for all fields.
  • ID Capture now supports full-frame anonymization.
  • The result of decodeMobileDriverLicenseViz, which is currently returned as part of the VizResult within CapturedId, will now be provided through a new field named mobileDocumentOcr.
  • Added CapturedId::isCitizenPassport, which indicates whether the passport was issued to a citizen of the issuing country. Returns false for travel documents such as refugee, stateless, or alien passports, and for any passports issued by organizations rather than states.
  • Removed the deprecated API DateResult::toDate. You should use DateResult::toLocalDate or DateResult::toUtcDate instead.

Web SDK Changes​

Starting with version 8.0, there are some critical changes in the Web SDK that you should be aware of:

Xamarin SDK Changes​

Starting this release we are no longer upgrading Xamarin and Forms solutions for the Data Capture SDK. Microsoft ended support for these frameworks on the 1st of May 2024, which locks them into discontinued tooling. You may continue to use the latest releases of SDK version 7.x as per our support policy.