LIQA™

Appearance

Migration from Light SDK v2 API ​

This page is designed to help clients migrate from the deprecated older version of LIQA to the current one. This page contains information for clients, utilising LIQA Light SDK v2 API, described in previous documentation.

Versions Comparison Summary ​

Featureprevious (SDK v2)current (web component v6)
Delivery methodNPMCDN
Integration methodSDKweb component
Image format by defaultbase64blob
User Interfacenot included ❌included, new design

Migration Steps ​

WARNING

We recommend to fully remove the previous LIQA version integration from the code of your application before start.

  1. Start by following the Quick Start integration with default settings
  2. Add a function to perform image conversion from blob to base64 to match the /upload SaaS API.
  3. If your application allows users to upload images from the device gallery, allow this option in the new LIQA by default and remove this feature from your application code.
  4. Customize the LIQA interface style and texts. See UI styling and text replacement documentation pages.
  5. Add error handling logic.
  6. Test your application on mobile devices. Check system requirements for the best performance.
  7. Check our recent updates regularly on the What's new? page.

Features Compatibility Notes ​

Lock version ​

The previous version (v2) offered a way to freeze LIQA version using a specific version from the NPM registry. The current version (v6) does not support this feature, as it receives automatic updates and bug fixes from the CDN.

Change container size ​

The previous version (v2) offered a way to set LIQA container size by passing width and height parameters to the init method. The current version (v6) provides LIQA as a native web component, so you can set the size of the container natively.

Manually start LIQA session ​

The previous version (v2) offered a way to start LIQA session by calling the .play() method. The current version (v6) starts LIQA session automatically after the web component is rendered. You can postpone the session start by changing the visibility of the web component, check the guide about hidden property.

Manually trigger photo capture ​

The previous version (v2) offered a way to trigger photo capture by calling the .captureSelfie(); method. The current version (v6) does not support this feature and supports only automatic photo capture.

Select image encoding format ​

The previous version (v2) offered a way to select image encoding format by passing limittingResolutionValue to the init method. The current version (v6) does not support this feature.

Limit maximum image size ​

The previous version (v2) offered a way to select image encoding format by passing jpegCompressionPercantage to the init method. The current version (v6) does not support this feature.

Exit LIQA session ​

The previous version (v2) offered a way to exit LIQA session by calling the .stop() method. The current version (v6) does not support this feature.