Get all Scan exchanger status codes
Get all SDK status codes
Create object to exchange data between devices
is object with ScanExchanger structure
Decrypt protected object
is encrypted object as string
is secret key with which data will be decrypted
Protect plain object
is plain object
us secret key with which data will be encrypted
Check if all requirements for desktop-to-mobile feature are available
Register global listener success and/or error callback
Scan image and get result from subscribed observable
Push image (file or video frame) to scanning queue, results will be handled by global listener(s)
Set authorization header which will be used in next request
is authorization header with apiKey and apiSecret which should be generated here: https://microblink.com/customer/api
Set HTTP API endpoint for next request
Change export images flag for next request
is flag which describes does API should return extracted images in next response
When Authorization is not set it is available to disable persiting of uploaded data, by default it is enabled this should be disabled for every page where GDPR is not implemented and this is ability to disable data persisting on some demo pages
is flag which describes should or should not API persist uploaded data, be default it is enabled
Set recognizers which will be used in next request
Set unique user ID which will be stored with uploaded image to associate image with user who uploaded the image
is string user identificator, recommended it to be an user's email because when delete request is sent by this email, all images associated with this email will be permanentally removed if it is stored on upload, not every image will be stored, this depends on other API key options
Terminate all queued HTTP requests. This is useful when images are sending from camera video stream in ms time periods and when successful result is received then all pending requests could be terminated, this should be primary used for application performance improvements, to break all HTTP connections which will return redundant results
Generated using TypeDoc
NOTE: This is public SDK API, rename of this functions will produce backward incompatible API!