404: Something's gone wrong :-(
- -You've tried to visit a page that doesn't exist. Luckily this site - has other pages.
-If you were looking for something specific, try searching: -
- - -You've tried to visit a page that doesn't exist. Luckily this site - has other pages.
-If you were looking for something specific, try searching: -
- - -Structure is used to describe the results of a single authentication -procedure or a procedure of secure data access within the context -of the communication session with electronic document.
-Index of the active variant of the procedure.
-int get activeOptionIdx => _activeOptionIdx;
-Allows you to deserialize object.
-static AccessControlProcedureType? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = AccessControlProcedureType();
-
- result._activeOptionIdx = jsonObject["activeOptionIdx"];
- result._type =
- RFIDAccessControlProcedureType.getByValue(jsonObject["type"])!;
- result._status = RFIDErrorCodes.getByValue(jsonObject["status"])!;
- result._notifications = jsonObject["notifications"].cast<int>();
-
- return result;
-}
-Procedure status.
-RFIDErrorCodes get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "activeOptionIdx": activeOptionIdx,
- "notifications": notifications,
- "status": status.value,
- "type": type.value,
- }.clearNulls();
-Procedure type.
-RFIDAccessControlProcedureType get type => _type;
-Structure is used to describe the contents of a single LDS applica-tion -and their analysis within the context of the communication session with -electronic document.
-Application identifier.
-String? get applicationID => _applicationID;
-Algorithm for calculating hash values for files for the proce-dure of PA.
-String? get dataHashAlgorithm => _dataHashAlgorithm;
-Allows you to deserialize object.
-static Application? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Application();
-
- result._type = jsonObject["type"];
- result._status = RFIDErrorCodes.getByValue(jsonObject["status"])!;
- result._applicationID = jsonObject["applicationID"];
- result._dataHashAlgorithm = jsonObject["dataHashAlgorithm"];
- result._unicodeVersion = jsonObject["unicodeVersion"];
- result._version = jsonObject["version"];
- for (var item in jsonObject["files"])
- result._files.addSafe(File.fromJson(item));
-
- return result;
-}
-Status of the application selection procedure.
-RFIDErrorCodes get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "applicationID": applicationID,
- "dataHashAlgorithm": dataHashAlgorithm,
- "files": files.map((e) => e.toJson()).toList(),
- "status": status.value,
- "type": type,
- "unicodeVersion": unicodeVersion,
- "version": version,
- }.clearNulls();
-Type of application of electronic document.
-int get type => _type;
-Unicode version for application.
-String? get unicodeVersion => _unicodeVersion;
-Application version.
-String? get version => _version;
-Allows you to deserialize object.
-static Attribute? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Attribute();
-
- result._type = jsonObject["type"];
- result._value = RFIDValue.fromJson(jsonObject["value"]);
-
- return result;
-}
-String? get type => _type;
-RFIDValue? get value => _value;
-Enumeration contains identifiers that determine the possibility -of performing different authenticity control procedures -using images for definite lighting schemes.
-Will be returned if getByValue if a non-existent was passed.
- - -Authenticity(-1)
- No authenticity control procedure provided for this document.
- - -Authenticity(0)
- Document material UV fluorescence control (check for presence of UV -dull paper) is provided for this document.
- - -Authenticity(1)
- Control of MRZ contrast using the image for IR lighting scheme -is provided for this document.
- - -Authenticity(2)
- Control of the presence of an image pattern with a specified color, -shape and brightness on a document page under white, UV and IR light.
- - -Authenticity(4)
- UV fluorescence of protection fibers control is provided for this document.
- - -Authenticity(8)
- Blank elements visibility control using the images for IR lighting scheme -is provided for this document.
- - -Authenticity(16)
- Authenticity control using the images for white coaxial light scheme -is provided for this document.
- - -Authenticity(32)
- Make OCR for the text field in UV and compare it with other text sources.
- - -Authenticity(64)
- Find invisible personal information images.
- - -Authenticity(128)
- Check photo is printed or sticked.
- - -Authenticity(512)
- OVI check.
- - -Authenticity(1024)
- Reserved for internal use.
- - -Authenticity(4096)
- Reserved for internal use.
- - -Authenticity(8192)
- Portrait comparison.
- - -Authenticity(32768)
- Barcode format check.
- - -Authenticity(65536)
- Kinegram.
- - -Authenticity(131072)
- Reserved for internal use.
- - -Authenticity(524288)
- Liveness.
- - -Authenticity(2097152)
- Extended OCR check.
- - -Authenticity(4194304)
- Checks the correctness of the size of the MRZ lines, their relative position, -absence of signs that the image was edited.
- - -Authenticity(8388608)
- Status only.
- - -Authenticity(2147483648)
- [UNKNOWN, NONE, UV_LUMINESCENCE, IR_B900, IMAGE_PATTERN, AXIAL_PROTECTION, UV_FIBERS, IR_VISIBILITY, OCR_SECURITY_TEXT, IPI, PHOTO_EMBED_TYPE, OVI, HOLOGRAMS, PHOTO_AREA, PORTRAIT_COMPARISON, BARCODE_…
- const Authenticity
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-List<AuthenticityElement> get elements => _elements;
-Allows you to deserialize object.
-static AuthenticityCheck? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = AuthenticityCheck();
-
- result._type = Authenticity.getByValue(jsonObject["type"])!;
- result._status = CheckResult.getByValue(jsonObject["status"])!;
- result._typeName = jsonObject["typeName"];
- result._pageIndex = jsonObject["pageIndex"];
- for (var item in jsonObject["elements"])
- result.elements.addSafe(AuthenticityElement.fromJson(item));
-
- return result;
-}
-int get pageIndex => _pageIndex;
-Indicates verification result.
-CheckResult get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "type": type.value,
- "status": status.value,
- "pageIndex": pageIndex,
- "typeName": typeName,
- "elements": elements.map((e) => e.toJson()).toList()
- }.clearNulls();
-Indicates verification type result.
-Authenticity get type => _type;
-String get typeName => _typeName;
-Indicates element diagnose.
-CheckDiagnose get elementDiagnose => _elementDiagnose;
-String get elementDiagnoseName => _elementDiagnoseName;
-Indicates element type.
-SecurityFeatureType get elementType => _elementType;
-String get elementTypeName => _elementTypeName;
-Allows you to deserialize object.
-static AuthenticityElement? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = AuthenticityElement();
-
- result._status = CheckResult.getByValue(jsonObject["status"])!;
- result._elementType =
- SecurityFeatureType.getByValue(jsonObject["elementType"])!;
- result._elementDiagnose =
- CheckDiagnose.getByValue(jsonObject["elementDiagnose"])!;
- result._elementTypeName = jsonObject["elementTypeName"];
- result._elementDiagnoseName = jsonObject["elementDiagnoseName"];
-
- return result;
-}
-Indicates verification result of the field.
-CheckResult get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "status": status.value,
- "elementType": elementType.value,
- "elementDiagnose": elementDiagnose.value,
- "elementTypeName": elementTypeName,
- "elementDiagnoseName": elementDiagnoseName,
- }.clearNulls();
-bool? get checkAxial => _checkAxial;
-set checkAxial(bool? val) {
- _checkAxial = val;
- _set({"checkAxial": val});
-}
-bool? get checkBarcodeFormat => _checkBarcodeFormat;
-set checkBarcodeFormat(bool? val) {
- _checkBarcodeFormat = val;
- _set({"checkBarcodeFormat": val});
-}
-bool? get checkExtMRZ => _checkExtMRZ;
-set checkExtMRZ(bool? val) {
- _checkExtMRZ = val;
- _set({"checkExtMRZ": val});
-}
-bool? get checkExtOCR => _checkExtOCR;
-set checkExtOCR(bool? val) {
- _checkExtOCR = val;
- _set({"checkExtOCR": val});
-}
-bool? get checkFibers => _checkFibers;
-set checkFibers(bool? val) {
- _checkFibers = val;
- _set({"checkFibers": val});
-}
-bool? get checkIRB900 => _checkIRB900;
-set checkIRB900(bool? val) {
- _checkIRB900 = val;
- _set({"checkIRB900": val});
-}
-bool? get checkIRVisibility => _checkIRVisibility;
-set checkIRVisibility(bool? val) {
- _checkIRVisibility = val;
- _set({"checkIRVisibility": val});
-}
-bool? get checkImagePatterns => _checkImagePatterns;
-set checkImagePatterns(bool? val) {
- _checkImagePatterns = val;
- _set({"checkImagePatterns": val});
-}
-bool? get checkLetterScreen => _checkLetterScreen;
-set checkLetterScreen(bool? val) {
- _checkLetterScreen = val;
- _set({"checkLetterScreen": val});
-}
-bool? get checkPhotoComparison => _checkPhotoComparison;
-set checkPhotoComparison(bool? val) {
- _checkPhotoComparison = val;
- _set({"checkPhotoComparison": val});
-}
-bool? get checkPhotoEmbedding => _checkPhotoEmbedding;
-set checkPhotoEmbedding(bool? val) {
- _checkPhotoEmbedding = val;
- _set({"checkPhotoEmbedding": val});
-}
-bool? get checkUVLuminiscence => _checkUVLuminiscence;
-set checkUVLuminiscence(bool? val) {
- _checkUVLuminiscence = val;
- _set({"checkUVLuminiscence": val});
-}
-Allows you to deserialize object.
-static AuthenticityParams fromJson(jsonObject) {
- if (jsonObject == null) return AuthenticityParams();
- var result = AuthenticityParams();
- result.testSetters = {};
-
- result.useLivenessCheck = jsonObject["useLivenessCheck"];
- result.livenessParams =
- LivenessParams.fromJson(jsonObject["livenessParams"]);
- result.checkUVLuminiscence = jsonObject["checkUVLuminiscence"];
- result.checkIRB900 = jsonObject["checkIRB900"];
- result.checkImagePatterns = jsonObject["checkImagePatterns"];
- result.checkFibers = jsonObject["checkFibers"];
- result.checkExtMRZ = jsonObject["checkExtMRZ"];
- result.checkExtOCR = jsonObject["checkExtOCR"];
- result.checkAxial = jsonObject["checkAxial"];
- result.checkBarcodeFormat = jsonObject["checkBarcodeFormat"];
- result.checkIRVisibility = jsonObject["checkIRVisibility"];
- result.checkIPI = jsonObject["checkIPI"];
- result.checkPhotoEmbedding = jsonObject["checkPhotoEmbedding"];
- result.checkPhotoComparison = jsonObject["checkPhotoComparison"];
- result.checkLetterScreen = jsonObject["checkLetterScreen"];
-
- return result;
-}
-LivenessParams get livenessParams => _livenessParams;
-set livenessParams(LivenessParams val) {
- (_livenessParams = val)._apply(this);
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "useLivenessCheck": useLivenessCheck,
- "livenessParams": livenessParams.toJson(),
- "checkUVLuminiscence": checkUVLuminiscence,
- "checkIRB900": checkIRB900,
- "checkImagePatterns": checkImagePatterns,
- "checkFibers": checkFibers,
- "checkExtMRZ": checkExtMRZ,
- "checkExtOCR": checkExtOCR,
- "checkAxial": checkAxial,
- "checkBarcodeFormat": checkBarcodeFormat,
- "checkIRVisibility": checkIRVisibility,
- "checkIPI": checkIPI,
- "checkPhotoEmbedding": checkPhotoEmbedding,
- "checkPhotoComparison": checkPhotoComparison,
- "checkLetterScreen": checkLetterScreen,
- }.clearNulls();
-This parameter is used to enable document liveness check.
-bool? get useLivenessCheck => _useLivenessCheck;
-set useLivenessCheck(bool? val) {
- _useLivenessCheck = val;
- _set({"useLivenessCheck": val});
-}
-List<AuthenticityCheck> get checks => _checks;
-Allows you to deserialize object.
-static AuthenticityResult? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = AuthenticityResult();
-
- result._status = CheckResult.getByValue(jsonObject["status"])!;
- for (var item in jsonObject["checks"])
- result._checks.addSafe(AuthenticityCheck.fromJson(item));
-
- return result;
-}
-CheckResult get status => _status;
-String? get data => _data;
-RFIDValue? get friendlyName => _friendlyName;
-Allows you to deserialize object.
-static Authority? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Authority();
-
- result._data = jsonObject["data"];
- result._friendlyName = RFIDValue.fromJson(jsonObject["friendlyName"]);
- for (var item in jsonObject["attributes"])
- result._attributes.addSafe(Attribute.fromJson(item));
-
- return result;
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "attributes": attributes.map((e) => e.toJson()).toList(),
- "data": data,
- "friendlyName": friendlyName?.toJson(),
- }.clearNulls();
-Allows you to deserialize object.
-static BackendProcessingConfig? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = BackendProcessingConfig(jsonObject["url"]);
-
- result._rfidServerSideChipVerification =
- jsonObject["rfidServerSideChipVerification"];
- if (jsonObject["httpHeaders"] != null)
- result._httpHeaders = Map<String, String>.from(jsonObject["httpHeaders"]);
-
- return result;
-}
-bool? get rfidServerSideChipVerification => _rfidServerSideChipVerification;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "url": url,
- "rfidServerSideChipVerification": rfidServerSideChipVerification,
- "httpHeaders": httpHeaders
- }.clearNulls();
-String get url => _url;
-Structure describing single value of the field.
-Decoded barcode type.
-BarcodeType get barcodeType => _barcodeType;
-Results of reading data from barcode modules.
-Uint8List? get data => _data;
-Allows you to deserialize object.
-static BarcodeField? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = BarcodeField();
-
- result._barcodeType = BarcodeType.getByValue(jsonObject["barcodeType"])!;
- result._status = BarcodeStatus.getByValue(jsonObject["status"])!;
- result._pageIndex = jsonObject["pageIndex"];
- result._pdf417Info = PDF417Info.fromJson(jsonObject["pdf417Info"]);
- result._data = _bytesFromBase64(jsonObject["data"]);
-
- return result;
-}
-Indicates an index of the document page, whence the result is received.
-int get pageIndex => _pageIndex;
-Contains the information about the PDF417 barcode.
-PDF417Info? get pdf417Info => _pdf417Info;
-Indicates barcode reading result.
-BarcodeStatus get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "barcodeType": barcodeType.value,
- "status": status.value,
- "pdf417Info": pdf417Info?.toJson(),
- "data": _bytesToBase64(data),
- "pageIndex": pageIndex,
- }.clearNulls();
-Structure, describing single barcode extracted.
-List<BarcodeField> get fields => _fields;
-Allows you to deserialize object.
-static BarcodeResult? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = BarcodeResult();
-
- for (var item in jsonObject["fields"])
- result._fields.addSafe(BarcodeField.fromJson(item));
-
- return result;
-}
-Will be returned if getByValue if a non-existent was passed.
- - -BarcodeStatus(-1)
- No error.
- - -BarcodeStatus(0)
- Null pointer of input arg/param error.
- - -BarcodeStatus(-6001)
- Function arg/param is bad.
- - -BarcodeStatus(-6002)
- Wrong value of data size.
- - -BarcodeStatus(-6003)
- Bad values of any parameter range.
- - -BarcodeStatus(-6004)
- Internal program error.
- - -BarcodeStatus(-6005)
- try-except process.
- - -BarcodeStatus(-6006)
- Barcode detection error.
- - -BarcodeStatus(-6008)
- Barcode decoding error.
- - -BarcodeStatus(-6010)
- "ImageProcess.dll" connection error.
- - -BarcodeStatus(-6019)
- IPP Dll connection error.
- - -BarcodeStatus(-6020)
- Run-time error in IPP-function.
- - -BarcodeStatus(-6024)
- try-except execution in IPP-function.
- - -BarcodeStatus(-6025)
- Input data error.
- - -BarcodeStatus(-11001)
- Initialization error.
- - -BarcodeStatus(-11006)
- "IpDecode.dll" connection error.
- - -BarcodeStatus(-11012)
- Internal program error.
- - -BarcodeStatus(-11100)
- 1D-barcode decoding error.
- - -BarcodeStatus(-11200)
- Row or Column count computational error (PDF417).
- - -BarcodeStatus(-11201)
- MinX computational error (PDF417).
- - -BarcodeStatus(-11202)
- MinY computational error (PDF417).
- - -BarcodeStatus(-11203)
- Invalid barcode angle (> 3 degree).
- - -BarcodeStatus(-11204)
- The result may contain decoding errors.
- - -BarcodeStatus(-11210)
- Dll initialization error.
- - -BarcodeStatus(-11300)
- try-except in IPDECODE-function.
- - -BarcodeStatus(-11400)
- Too many invalid code words.
- - -BarcodeStatus(-4503)
- Invalid number of columns.
- - -BarcodeStatus(-4504)
- Invalid number of rows.
- - -BarcodeStatus(-4505)
- Correction Level error.
- - -BarcodeStatus(-4511)
- Loading "DevTable.bin" error.
- - -BarcodeStatus(-4512)
- [UNKNOWN, NO_ERR, NULL_PTR_ERR, BAD_ARG_ERR, SIZE_ERR, RANGE_ERR, INTERNAL_ERR, TRY_EXCEPT_ERR, BAR_CODE_NOT_FOUND, BAR_CODE_DECODE_ERR, NO_USER_DLL_FOUND, NO_IPP_DLL_FOUND, IPP_EXEC_ERR, IPP_TRY_EXCE…
- const BarcodeStatus
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Enumeration contains the types of barcodes that can be processed.
-Unknown.
- - -BarcodeType(0)
- One-dimensional barcode, ISO 15417 (ANSI/AIM BC4-1999 Code 128).
- - -BarcodeType(1)
- One-dimensional barcode, ISO 16388 (ANSI/AIM BC1-1995 Code 39).
- - -BarcodeType(2)
- One-dimensional barcode, EAN8, ISO 15418.
- - -BarcodeType(3)
- One-dimensional barcode, Interleaved 2 of 5, ISO 16390 (ANSI/AIM BC2-1995 Interleaved 2 of 5).
- - -BarcodeType(4)
- Two-dimensional barcode, ISO 15438 (AIM USS PDF417).
- - -BarcodeType(5)
- One-dimensional barcode, Standard 2 of 5 (Industrial).
- - -BarcodeType(6)
- One-dimensional barcode, Matrix 2 of 5.
- - -BarcodeType(7)
- One-dimensional barcode, IATA 2 of 5 (Airline).
- - -BarcodeType(8)
- One-dimensional barcode, (ANSI/AIM BC3-1995, USS - Codabar).
- - -BarcodeType(9)
- One-dimensional barcode, UPC-A.
- - -BarcodeType(10)
- One-dimensional barcode, (ANSI/AIM BC5-1995, USS - Code 93).
- - -BarcodeType(11)
- One-dimensional barcode, UPC-E.
- - -BarcodeType(12)
- One-dimensional barcode, EAN13, ISO 15418.
- - -BarcodeType(13)
- Two-dimensional QR barcode.
- - -BarcodeType(14)
- Two-dimensional AZTEC barcode.
- - -BarcodeType(15)
- Two-dimensional DATAMATRIX barcode.
- - -BarcodeType(16)
- One-dimensional barcodes.
- - -BarcodeType(17)
- One-dimensional barcode, Code 11.
- - -BarcodeType(18)
- Two-dimensional barcode, JAB Code
- - -BarcodeType(19)
- [UNKNOWN, BCT_CODE128, CODE39, EAN8, ITF, PDF417, STF, MTF, IATA, CODABAR, UPCA, CODE93, UPCE, EAN13, QRCODE, AZTEC, DATAMATRIX, ALL_1D, CODE11, JABCODE]
- const BarcodeType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Keeps user notified about btDevice`s connection state. -Used in DocumentReader.startBluetoothService
-onServiceConnected fires when android`s bluetooth service is initialized.
-onServiceDisconnected fires when android`s bluetooth service is destroyed.
-onDeviceReady fires when a bluetooth device is connected and ready to use.
-DocumentReader.initializeReaderWithBleDeviceConfig should be run here.
Android only.
-void onDeviceReady();
-void onServiceConnected(bool isBleManagerConnected);
-void onServiceDisconnected();
-String get data => _data;
-Allows you to deserialize object.
-static BytesData? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = BytesData();
-
- result._data = jsonObject["data"];
- result._length = jsonObject["length"];
- result._status = jsonObject["status"];
- result._type = jsonObject["type"];
-
- return result;
-}
-int get length => _length;
-int get status => _status;
-int get type => _type;
-Will be returned if getByValue if a non-existent was passed.
- - -CameraMode(-1)
- CameraMode(0)
- CameraMode(1)
- CameraMode(2)
- [UNKNOWN, AUTO, CAMERA1, CAMERA2]
- const CameraMode
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Will be returned if getByValue if a non-existent was passed.
- - -CameraPosition(-1)
- CameraPosition(0)
- CameraPosition(1)
- CameraPosition(2)
- [UNKNOWN, UNSPECIFIED, BACK, FRONT]
- const CameraPosition
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Allows you to deserialize object.
-static CameraSize? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return CameraSize(
- jsonObject["width"],
- jsonObject["height"],
- );
-}
-int get height => _height;
-int get width => _width;
-Will be returned if getByValue if a non-existent was passed.
- - -Cap(-1)
- Cap(0)
- Cap(1)
- Cap(2)
- const Cap
-final int value;
-Will be returned if getByValue if a non-existent was passed.
- - -CaptureMode(-1)
- A flow of frames is taken for recognition right after a scenario is started.
- - -CaptureMode(0)
- A flow of frames is taken for recognition right after the Capture button is pushed.
- - -CaptureMode(1)
- A single frame is taken for recognition right after the Capture button is pushed.
- - -CaptureMode(2)
- [UNKNOWN, AUTO, CAPTURE_VIDEO, CAPTURE_FRAME]
- const CaptureMode
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Will be returned if getByValue if a non-existent was passed.
- - -CaptureSessionPreset(-1)
- An AVCaptureSession preset suitable for low quality output.
- - -CaptureSessionPreset(0)
- An AVCaptureSession preset suitable for medium quality output.
- - -CaptureSessionPreset(1)
- An AVCaptureSession preset suitable for high quality video and audio output.
- - -CaptureSessionPreset(2)
- CaptureSessionPreset(3)
- An AVCaptureSession preset indicating that the formats of the session's -inputs are being given priority.
- - -CaptureSessionPreset(4)
- An AVCaptureSession preset suitable for 1280x720 video output.
- - -CaptureSessionPreset(6)
- An AVCaptureSession preset suitable for 1920x1080 video output.
- - -CaptureSessionPreset(7)
- An AVCaptureSession preset suitable for 3840x2160 (UHD 4K) video output.
- - -CaptureSessionPreset(8)
- An AVCaptureSession preset producing 960x540 Apple iFrame video and audio content.
- - -CaptureSessionPreset(9)
- An AVCaptureSession preset producing 1280x720 Apple iFrame video and audio content.
- - -CaptureSessionPreset(10)
- An AVCaptureSession preset suitable for 640x480 video output.
- - -CaptureSessionPreset(12)
- An AVCaptureSession preset suitable for 352x288 video output.
- - -CaptureSessionPreset(13)
- [UNKNOWN, LOW, MEDIUM, HIGH, PHOTO, INPUT_PRIORITY, PRESET_1280x720, PRESET_1920x1080, PRESET_3840x2160, FRAME_960x540, FRAME_1280x720, PRESET_640x480, PRESET_352x288]
- const CaptureSessionPreset
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Structure is used to store extended information about the characteristics -of the RFID-chip located in the scope of the reader.
-Numeric ATQ_A value in hexadecimal format (e.g. "0x0000").
-int get aTQA => _aTQA;
-ATQ_B contents in text format. Each byte is represented by its -hexadecimal value. The individual bytes are sepa-rated by spaces -(e.g. "50 F9 4F 41 60 00 00 00 00 77 81 81").
-String? get aTQB => _aTQB;
-aTR contents in text format. Each byte is represented by its hexadecimal value. -The individual bytes are separated by spaces -(e.g. "3B 88 81 11 FC 00 00 00 00 77 81 81 00 93").
-String? get aTR => _aTR;
-Numeric Baudrate1 value in hexadecimal format (e.g. "0x0000000F").
-String? get baudrate1 => _baudrate1;
-Numeric Baudrate2 value in hexadecimal format.
-String? get baudrate2 => _baudrate2;
-Numeric BitRateR value in hexadecimal format (e.g. "0x04").
-int get bitRateR => _bitRateR;
-Numeric BitRateS value in hexadecimal format (e.g. "0x04").
-int get bitRateS => _bitRateS;
-Text abbreviation of ChipType_A value.
-int get chipTypeA => _chipTypeA;
-Allows you to deserialize object.
-static CardProperties? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = CardProperties();
-
- result._aTQA = jsonObject["aTQA"];
- result._bitRateR = jsonObject["bitRateR"];
- result._bitRateS = jsonObject["bitRateS"];
- result._chipTypeA = jsonObject["chipTypeA"];
- result._mifareMemory = jsonObject["mifareMemory"];
- result._rfidType = jsonObject["rfidType"];
- result._sAK = jsonObject["sAK"];
- result._support4 = jsonObject["support4"];
- result._supportMifare = jsonObject["supportMifare"];
- result._aTQB = jsonObject["aTQB"];
- result._aTR = jsonObject["aTR"];
- result._baudrate1 = jsonObject["baudrate1"];
- result._baudrate2 = jsonObject["baudrate2"];
- result._uID = jsonObject["uID"];
-
- return result;
-}
-Numeric MifareMemory value.
-int get mifareMemory => _mifareMemory;
-Text abbreviation of RFID_Type value.
-int get rfidType => _rfidType;
-Numeric SAK value in hexadecimal format (e.g. "0x00").
-int get sAK => _sAK;
-Boolean Support_4 value.
-bool get support4 => _support4;
-Boolean Support_Mifare value.
-bool get supportMifare => _supportMifare;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "aTQA": aTQA,
- "bitRateR": bitRateR,
- "bitRateS": bitRateS,
- "chipTypeA": chipTypeA,
- "mifareMemory": mifareMemory,
- "rfidType": rfidType,
- "sAK": sAK,
- "support4": support4,
- "supportMifare": supportMifare,
- "aTQB": aTQB,
- "aTR": aTR,
- "baudrate1": baudrate1,
- "baudrate2": baudrate2,
- "uID": uID,
- }.clearNulls();
-UID contents in text format. Each byte is represented by its hexadecimal value. -The individual bytes are separated by spaces (e.g. "F9 4F 41 60").
-String? get uID => _uID;
-RFIDValue? get fileName => _fileName;
-Allows you to deserialize object.
-static CertificateChain? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = CertificateChain();
-
- result._origin = jsonObject["origin"];
- result._type = RFIDCertificateType.getByValue(jsonObject["type"])!;
- result._version = jsonObject["version"];
- result._paStatus = jsonObject["paStatus"];
- result._serialNumber = jsonObject["serialNumber"];
- result._signatureAlgorithm = jsonObject["signatureAlgorithm"];
- result._subjectPKAlgorithm = jsonObject["subjectPKAlgorithm"];
- result._fileName = RFIDValue.fromJson(jsonObject["fileName"]);
- result._validity = RFIDValidity.fromJson(jsonObject["validity"]);
- result._issuer = Authority.fromJson(jsonObject["issuer"]);
- result._subject = Authority.fromJson(jsonObject["subject"]);
- result._notifications = jsonObject["notifications"].cast<int>();
- for (var item in jsonObject["extensions"])
- result._extensions.addSafe(Extension.fromJson(item));
-
- return result;
-}
-Authority? get issuer => _issuer;
-int get origin => _origin;
-int get paStatus => _paStatus;
-String? get serialNumber => _serialNumber;
-String? get signatureAlgorithm => _signatureAlgorithm;
-Authority? get subject => _subject;
-String? get subjectPKAlgorithm => _subjectPKAlgorithm;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "type": type.value,
- "extensions": extensions.map((e) => e.toJson()).toList(),
- "fileName": fileName?.toJson(),
- "issuer": issuer?.toJson(),
- "notifications": notifications,
- "origin": origin,
- "paStatus": paStatus,
- "serialNumber": serialNumber,
- "signatureAlgorithm": signatureAlgorithm,
- "subject": subject?.toJson(),
- "subjectPKAlgorithm": subjectPKAlgorithm,
- "validity": validity?.toJson(),
- "version": version,
- }.clearNulls();
-Define the type of certificate used in the procedure of document -security object digital signature verification.
-RFIDCertificateType get type => _type;
-RFIDValidity? get validity => _validity;
-int get version => _version;
-String? get data => _data;
-Allows you to deserialize object.
-static CertificateData? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = CertificateData();
-
- result._length = jsonObject["length"];
- result._data = jsonObject["data"];
-
- return result;
-}
-int get length => _length;
-Enumeration contains identificators that determine the result of the -text field comparison from different sources.
-Check was not performed.
- - -CheckDiagnose(0)
- Check was ok.
- - -CheckDiagnose(1)
- Invalid input data.
- - -CheckDiagnose(2)
- Internal error in module.
- - -CheckDiagnose(3)
- Exception caught
- - -CheckDiagnose(4)
- Can't make reliable decision.
- - -CheckDiagnose(5)
- Image in necessary light is not found.
- - -CheckDiagnose(7)
- Necessary side of photo not found.
- - -CheckDiagnose(8)
- Invalid checksum.
- - -CheckDiagnose(10)
- Syntactical error.
- - -CheckDiagnose(11)
- Logical error.
- - -CheckDiagnose(12)
- Comparison was incorrect.
- - -CheckDiagnose(13)
- Logical error, e.g. the current date is less than issue date.
- - -CheckDiagnose(14)
- Wrong field format.
- - -CheckDiagnose(15)
- Element of the luminescense in the UV does not meet the standard.
- - -CheckDiagnose(20)
- The presence of excess luminescence in UV.
- - -CheckDiagnose(21)
- Pattern does not match the standard.
- - -CheckDiagnose(22)
- Low contrast of object in transmitted IR light.
- - -CheckDiagnose(23)
- Background of page is too light or has invalid color.
- - -CheckDiagnose(24)
- Background lightness of two pages is different.
- - -CheckDiagnose(25)
- Text has incorrect color of luminescence in UV light.
- - -CheckDiagnose(26)
- Invalid luminescence in photo area.
- - -CheckDiagnose(27)
- Object is too shifted from standard coordinates.
- - -CheckDiagnose(28)
- Contact chip type mismatch.
- - -CheckDiagnose(29)
- No protective fibers were found in UV.
- - -CheckDiagnose(30)
- Error finding fibers, too many objects.
- - -CheckDiagnose(31)
- Speck or exposure in UV image.
- - -CheckDiagnose(33)
- Resolution too low for fibers search.
- - -CheckDiagnose(34)
- Erroneous visibility of the element in IR.
- - -CheckDiagnose(40)
- Element is absent in IR.
- - -CheckDiagnose(41)
- Element should be in color.
- - -CheckDiagnose(42)
- Element should be in grayscale.
- - -CheckDiagnose(43)
- CheckDiagnose(44)
- Glow paper in MRZ.
- - -CheckDiagnose(50)
- Luminescence characters in MRZ.
- - -CheckDiagnose(51)
- Glow in the field of photo paper.
- - -CheckDiagnose(52)
- Glow of the whole paper form.
- - -CheckDiagnose(53)
- Glow of the document in UV.
- - -CheckDiagnose(54)
- Element of blank has luminescence.
- - -CheckDiagnose(55)
- Violation of the retro-reflective protection.
- - -CheckDiagnose(60)
- Invalid params for IPI check.
- - -CheckDiagnose(65)
- IR image too bright.
- - -CheckDiagnose(80)
- Glares in photo area.
- - -CheckDiagnose(81)
- Photo replaced.
- - -CheckDiagnose(82)
- OVI object is not visible in IR.
- - -CheckDiagnose(90)
- Insufficient area of the object OVI.
- - -CheckDiagnose(91)
- OVI color of an object does not change.
- - -CheckDiagnose(92)
- Impossible to determine the color of the AXIAL image.
- - -CheckDiagnose(93)
- Impossible to determine the color of the WHITE image.
- - -CheckDiagnose(94)
- Wide color spread.
- - -CheckDiagnose(95)
- Not enough color information.
- - -CheckDiagnose(96)
- Hologram element absent.
- - -CheckDiagnose(100)
- There are no side or top images. Check cancelled.
- - -CheckDiagnose(101)
- Hologram element present.
- - -CheckDiagnose(102)
- CheckDiagnose(103)
- CheckDiagnose(104)
- Pattern is interrupted.
- - -CheckDiagnose(110)
- Some of the patterns are shifted relative to each other.
- - -CheckDiagnose(111)
- Some parts of the pattern have different color.
- - -CheckDiagnose(112)
- Pattern visible in the infrared.
- - -CheckDiagnose(113)
- Edge of the photo does not intersect with the pattern. Check cancelled.
- - -CheckDiagnose(114)
- Size of the photo does not correspond to requirements.
- - -CheckDiagnose(115)
- Some parts of the pattern have invalid color.
- - -CheckDiagnose(116)
- Some patterns are relatively shifted.
- - -CheckDiagnose(117)
- Not found Pattern. Check cancelled.
- - -CheckDiagnose(118)
- Different lines thickness.
- - -CheckDiagnose(119)
- Photo shape is not rectangular.
- - -CheckDiagnose(120)
- Photo corners don't meet the requirements.
- - -CheckDiagnose(121)
- For internal use only.
- - -CheckDiagnose(122)
- Text color should be blue.
- - -CheckDiagnose(130)
- Text color should be green.
- - -CheckDiagnose(131)
- Text color should be red.
- - -CheckDiagnose(132)
- Text should be black.
- - -CheckDiagnose(133)
- Barcode read with errors.
- - -CheckDiagnose(140)
- Barcode data format error.
- - -CheckDiagnose(141)
- Barcode size parameters error.
- - -CheckDiagnose(142)
- Not all barcodes read.
- - -CheckDiagnose(143)
- Glares in barcode area.
- - -CheckDiagnose(144)
- Portraits differ.
- - -CheckDiagnose(150)
- No reply from portrait comparison service.
- - -CheckDiagnose(151)
- Portrait comparison service error.
- - -CheckDiagnose(152)
- Not enough images.
- - -CheckDiagnose(153)
- No image from camera.
- - -CheckDiagnose(154)
- No license on portrait comparison service.
- - -CheckDiagnose(155)
- No portraits detected
- - -CheckDiagnose(156)
- Unsuitable light conditions.
- - -CheckDiagnose(160)
- No difference in visible and UV mobile images. Possible UV torch malfunction.
- - -CheckDiagnose(161)
- Fingerprints comparison mismatch.
- - -CheckDiagnose(170)
- Face isn’t detected.
- - -CheckDiagnose(180)
- Face comparison failed.
- - -CheckDiagnose(181)
- Glare in center absent.
- - -CheckDiagnose(182)
- Hologram element shape error.
- - -CheckDiagnose(183)
- Algorithm steps error.
- - -CheckDiagnose(184)
- Hologram areas not loaded.
- - -CheckDiagnose(185)
- Hologram check finished by time out.
- - -CheckDiagnose(186)
- CheckDiagnose(187)
- CheckDiagnose(190)
- Hologram check finished by time out.
- - -CheckDiagnose(200)
- Wrong background.
- - -CheckDiagnose(201)
- CheckDiagnose(202)
- CheckDiagnose(203)
- CheckDiagnose(204)
- CheckDiagnose(205)
- CheckDiagnose(220)
- CheckDiagnose(221)
- CheckDiagnose(222)
- CheckDiagnose(230)
- Traces of an electronic device were found in the image.
- - -CheckDiagnose(240)
- Invalid barcode background.
- - -CheckDiagnose(241)
- CheckDiagnose(243)
- CheckDiagnose(244)
- CheckDiagnose(245)
- CheckDiagnose(246)
- CheckDiagnose(247)
- CheckDiagnose(248)
- For internal use.
- - -CheckDiagnose(250)
- [UNKNOWN, PASS, INVALID_INPUT_DATA, INTERNAL_ERROR, EXCEPTION_IN_MODULE, UNCERTAIN_VERIFICATION, NECESSARY_IMAGE_NOT_FOUND, PHOTO_SIDES_NOT_FOUND, INVALID_CHECKSUM, SYNTAX_ERROR, LOGIC_ERROR, SOURCES_…
- const CheckDiagnose
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Will be returned if getByValue if a non-existent was passed.
- - -CheckResult(-1)
- Check was not passed, the controlled parameter is not permitted.
- - -CheckResult(0)
- Check was passed, the controlled parameter is permitted.
- - -CheckResult(1)
- Check was not carried out.
- - -CheckResult(2)
- [UNKNOWN, ERROR, OK, WAS_NOT_DONE]
- const CheckResult
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Callback for receiving signal when RFID chip is recognized -by a phone and chip reading is started.
-Only used with default constructor. If RFIDConfig.withoutUI was used, -you will receive this update via DocumentReaderCompletion.
-typedef ChipDetectedCompletion = void Function();
-Structure describing single value of the field.
-Allows you to deserialize object.
-static Comparison? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Comparison();
-
- result._sourceTypeLeft =
- ResultType.getByValue(jsonObject["sourceTypeLeft"])!;
- result._sourceTypeRight =
- ResultType.getByValue(jsonObject["sourceTypeRight"])!;
- result._status = CheckResult.getByValue(jsonObject["status"])!;
-
- return result;
-}
-The value's origin source.
-ResultType get sourceTypeLeft => _sourceTypeLeft;
-The value's origin source.
-ResultType get sourceTypeRight => _sourceTypeRight;
-The status of field comparisons.
-CheckResult get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "sourceTypeLeft": sourceTypeLeft.value,
- "sourceTypeRight": sourceTypeRight.value,
- "status": status.value,
- }.clearNulls();
-Structure describing point coordinate.
-Allows you to deserialize object.
-static Coordinate? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Coordinate();
-
- result._x = jsonObject["x"];
- result._y = jsonObject["y"];
-
- return result;
-}
-int get x => _x;
-int get y => _y;
-Button tags for UI customization.
-Will be returned if getByValue if a non-existent was passed.
- - -CustomButtonTag(-1)
- CustomButtonTag(1001)
- CustomButtonTag(1002)
- CustomButtonTag(1003)
- CustomButtonTag(1004)
- CustomButtonTag(1005)
- CustomButtonTag(1006)
- [UNKNOWN, CLOSE, TORCH, CAPTURE, CHANGE_FRAME, SKIP, CAMERA_SWITCH]
- const CustomButtonTag
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Callback for receiving signal, when a custom button, -configured in Customization.uiCustomizationLayer, is pressed.
-tag button id, indication which button was pressed.
typedef CustomButtonTappedCompletion = void Function(int tag);
-Params that relate to the camera view controller customization and etc.
-true, the background mask next to the camera frame
-will be displayed.
- true, the animation showing how to position a document
-will be displayed.
- true, the animation asking for processing
-the next page will be displayed.
- true, result status messages during the document processing
-will be shown.
- true, status messages during the document processing
-will be shown.
- Allows you to set a color for the activity indicator.
-Color? get activityIndicatorColor => _activityIndicatorColor;
-set activityIndicatorColor(Color? val) {
- _activityIndicatorColor = val;
- _set({"activityIndicatorColor": _intFromColor(val)});
-}
-Allows you to set intensity of the background mask.
-Default: 0.3.
-double? get backgroundMaskAlpha => _backgroundMaskAlpha;
-set backgroundMaskAlpha(double? val) {
- _backgroundMaskAlpha = val;
- _set({"backgroundMaskAlpha": val});
-}
-Allows you to set any image within the camera frame.
-ByteData? get borderBackgroundImage => _borderBackgroundImage;
-set borderBackgroundImage(ByteData? val) {
- _borderBackgroundImage = val;
- _set({"borderBackgroundImage": _dataToBase64(val)});
-}
-Matrix used to scale the view within the camera frame.
-Android class android.graphics.Matrix.
-Passed as Matrix.setValues()
Android only. For iOS use borderBackgroundImageTransformsIOS.
-List<double>? get borderBackgroundImageTransformsAndroid =>
- _borderBackgroundImageTransformsAndroid;
-set borderBackgroundImageTransformsAndroid(List<double>? val) {
- _borderBackgroundImageTransformsAndroid = val;
- _set({"borderBackgroundImageMatrix": val});
-}
-Allows you to specify how a view within the camera frame adjusts -its content when its size changes.
-Default: ViewContentMode.SCALE_ASPECT_FIT.
-IOS only. For Android use borderBackgroundImageTransformsAndroid.
-ViewContentMode? get borderBackgroundImageTransformsIOS =>
- _borderBackgroundImageTransformsIOS;
-set borderBackgroundImageTransformsIOS(ViewContentMode? val) {
- _borderBackgroundImageTransformsIOS = val;
- _set({"borderBackgroundImageContentMode": val?.value});
-}
-Allows you to set a color for the camera frame when a document is detected.
-Default: Colors.green.
-Color? get cameraFrameActiveColor => _cameraFrameActiveColor;
-set cameraFrameActiveColor(Color? val) {
- _cameraFrameActiveColor = val;
- _set({"cameraFrameActiveColor": _intFromColor(val)});
-}
-Allows you to set thickness of the camera frame borders.
-Default: 3.
-int? get cameraFrameBorderWidth => _cameraFrameBorderWidth;
-set cameraFrameBorderWidth(int? val) {
- _cameraFrameBorderWidth = val;
- _set({"cameraFrameBorderWidth": val});
-}
-Allows you to set a corner radius of the camera frame.
-Default: 10.
-double? get cameraFrameCornerRadius => _cameraFrameCornerRadius;
-set cameraFrameCornerRadius(double? val) {
- _cameraFrameCornerRadius = val;
- _set({"cameraFrameCornerRadius": val});
-}
-Allows you to set a color for the camera frame when a document is out -of the camera frame or is not detected.
-Default: Colors.white.
-Color? get cameraFrameDefaultColor => _cameraFrameDefaultColor;
-set cameraFrameDefaultColor(Color? val) {
- _cameraFrameDefaultColor = val;
- _set({"cameraFrameDefaultColor": _intFromColor(val)});
-}
-Allows you to set an aspect ratio of the camera frame (landscape orientation). -Default: 0.
-double? get cameraFrameLandscapeAspectRatio =>
- _cameraFrameLandscapeAspectRatio;
-set cameraFrameLandscapeAspectRatio(double? val) {
- _cameraFrameLandscapeAspectRatio = val;
- _set({"cameraFrameLandscapeAspectRatio": val});
-}
-Allows you to customize the beginning and ending of stroked lines -of the camera frame.
-Default: Cap.BUTT.
-Cap? get cameraFrameLineCap => _cameraFrameLineCap;
-set cameraFrameLineCap(Cap? val) {
- _cameraFrameLineCap = val;
- _set({"cameraFrameLineCap": val?.value});
-}
-Allows you to set length of the lines of the camera frame.
-It's applied once you change the cameraFrameShapeType property to -FrameShapeType.CORNER.
-Default: 25.
-int? get cameraFrameLineLength => _cameraFrameLineLength;
-set cameraFrameLineLength(int? val) {
- _cameraFrameLineLength = val;
- _set({"cameraFrameLineLength": val});
-}
-Allows you to set an offset for the camera frame (portrait orientation).
-Default: 3.
-int? get cameraFrameOffsetWidth => _cameraFrameOffsetWidth;
-set cameraFrameOffsetWidth(int? val) {
- _cameraFrameOffsetWidth = val;
- _set({"cameraFrameOffsetWidth": val});
-}
-Allows you to set an aspect ratio of the camera frame (portrait orientation).
-Default: 0.
-double? get cameraFramePortraitAspectRatio => _cameraFramePortraitAspectRatio;
-set cameraFramePortraitAspectRatio(double? val) {
- _cameraFramePortraitAspectRatio = val;
- _set({"cameraFramePortraitAspectRatio": val});
-}
-Allows you to set a shape type for the camera frame.
-Default: FrameShapeType.LINE.
-FrameShapeType? get cameraFrameShapeType => _cameraFrameShapeType;
-set cameraFrameShapeType(FrameShapeType? val) {
- _cameraFrameShapeType = val;
- _set({"cameraFrameShapeType": val?.value});
-}
-Allows you to change the location of the camera frame vertically.
-double? get cameraFrameVerticalPositionMultiplier =>
- _cameraFrameVerticalPositionMultiplier;
-set cameraFrameVerticalPositionMultiplier(double? val) {
- _cameraFrameVerticalPositionMultiplier = val;
- _set({"cameraFrameVerticalPositionMultiplier": val});
-}
-Allows you to set a background color for the camera preview -(top and bottom frames).
-Default: Colors.black.
-Color? get cameraPreviewBackgroundColor => _cameraPreviewBackgroundColor;
-set cameraPreviewBackgroundColor(Color? val) {
- _cameraPreviewBackgroundColor = val;
- _set({"cameraPreviewBackgroundColor": _intFromColor(val)});
-}
-Allows you to set any image for the button that allows -changing positions of the capture device.
-ByteData? get cameraSwitchButtonImage => _cameraSwitchButtonImage;
-set cameraSwitchButtonImage(ByteData? val) {
- _cameraSwitchButtonImage = val;
- _set({"cameraSwitchButtonImage": _dataToBase64(val)});
-}
-Allows you to set any image for the capture button.
-ByteData? get captureButtonImage => _captureButtonImage;
-set captureButtonImage(ByteData? val) {
- _captureButtonImage = val;
- _set({"captureButtonImage": _dataToBase64(val)});
-}
-Allows you to set any image for the button that allows changing -shapes of the camera (collapsed state).
-ByteData? get changeFrameButtonCollapseImage =>
- _changeFrameButtonCollapseImage;
-set changeFrameButtonCollapseImage(ByteData? val) {
- _changeFrameButtonCollapseImage = val;
- _set({"changeFrameButtonCollapseImage": _dataToBase64(val)});
-}
-Allows you to set any image for the button that allows changing -shapes of the camera (expanded state).
-ByteData? get changeFrameButtonExpandImage => _changeFrameButtonExpandImage;
-set changeFrameButtonExpandImage(ByteData? val) {
- _changeFrameButtonExpandImage = val;
- _set({"changeFrameButtonExpandImage": _dataToBase64(val)});
-}
-Allows you to set any image for the close button.
-ByteData? get closeButtonImage => _closeButtonImage;
-set closeButtonImage(ByteData? val) {
- _closeButtonImage = val;
- _set({"closeButtonImage": _dataToBase64(val)});
-}
-CustomizationColors get colors => _colors;
-set colors(CustomizationColors val) {
- (_colors = val)._apply(this);
-}
-Allows you to create a custom status.
-String? get customLabelStatus => _customLabelStatus;
-set customLabelStatus(String? val) {
- _customLabelStatus = val;
- _set({"customLabelStatus": val});
-}
-Allows you to change the location of the custom status.
-For example, if you set the multiplier to 0.5 and the number of pixels -by vertical is equal to 800, your message will be centralized and located -at 200 px from the top, i.e. (800 / 2) * 0.5 = 200 px. If the multiplier -is equal to 1, the message will be centered. If the multiplier is equal -to zero, the default location will be used.
-Default: 1.
-double? get customStatusPositionMultiplier => _customStatusPositionMultiplier;
-set customStatusPositionMultiplier(double? val) {
- _customStatusPositionMultiplier = val;
- _set({"customStatusPositionMultiplier": val});
-}
-CustomizationFonts get fonts => _fonts;
-set fonts(CustomizationFonts val) {
- (_fonts = val)._apply(this);
-}
-Allows you to deserialize object.
-static Customization fromJson(jsonObject) {
- var result = Customization();
- result.testSetters = {};
-
- result.showStatusMessages = jsonObject["showStatusMessages"];
- result.showResultStatusMessages = jsonObject["showResultStatusMessages"];
- result.showHelpAnimation = jsonObject["showHelpAnimation"];
- result.showNextPageAnimation = jsonObject["showNextPageAnimation"];
- result.showBackgroundMask = jsonObject["showBackgroundMask"];
-
- result.cameraFrameBorderWidth = jsonObject["cameraFrameBorderWidth"];
- result.cameraFrameLineLength = jsonObject["cameraFrameLineLength"];
- result.cameraFrameShapeType =
- FrameShapeType.getByValue(jsonObject["cameraFrameShapeType"]);
- result.cameraFrameOffsetWidth = jsonObject["cameraFrameOffsetWidth"];
-
- result.status = jsonObject["status"];
- result.resultStatus = jsonObject["resultStatus"];
-
- result.cameraFrameDefaultColor =
- _intToColor(jsonObject["cameraFrameDefaultColor"]);
- result.cameraFrameActiveColor =
- _intToColor(jsonObject["cameraFrameActiveColor"]);
- result.statusTextColor = _intToColor(jsonObject["statusTextColor"]);
- result.resultStatusTextColor =
- _intToColor(jsonObject["resultStatusTextColor"]);
- result.resultStatusBackgroundColor =
- _intToColor(jsonObject["resultStatusBackgroundColor"]);
- result.multipageButtonBackgroundColor =
- _intToColor(jsonObject["multipageButtonBackgroundColor"]);
- result.tintColor = _intToColor(jsonObject["tintColor"]);
- result.activityIndicatorColor =
- _intToColor(jsonObject["activityIndicatorColor"]);
- result.statusBackgroundColor =
- _intToColor(jsonObject["statusBackgroundColor"]);
- result.cameraPreviewBackgroundColor =
- _intToColor(jsonObject["cameraPreviewBackgroundColor"]);
-
- result.statusPositionMultiplier =
- _toDouble(jsonObject["statusPositionMultiplier"]);
- result.resultStatusPositionMultiplier =
- _toDouble(jsonObject["resultStatusPositionMultiplier"]);
- result.toolbarSize = _toDouble(jsonObject["toolbarSize"]);
- result.backgroundMaskAlpha = _toDouble(jsonObject["backgroundMaskAlpha"]);
- result.customStatusPositionMultiplier =
- _toDouble(jsonObject["customStatusPositionMultiplier"]);
- result.cameraFrameVerticalPositionMultiplier =
- _toDouble(jsonObject["cameraFrameVerticalPositionMultiplier"]);
- result.cameraFrameLandscapeAspectRatio =
- _toDouble(jsonObject["cameraFrameLandscapeAspectRatio"]);
- result.cameraFrameCornerRadius =
- _toDouble(jsonObject["cameraFrameCornerRadius"]);
- result.cameraFramePortraitAspectRatio =
- _toDouble(jsonObject["cameraFramePortraitAspectRatio"]);
- result.livenessAnimationPositionMultiplier =
- _toDouble(jsonObject["livenessAnimationPositionMultiplier"]);
-
- result.multipageAnimationFrontImage =
- _dataFromBase64(jsonObject["multipageAnimationFrontImage"]);
- result.multipageAnimationBackImage =
- _dataFromBase64(jsonObject["multipageAnimationBackImage"]);
- result.borderBackgroundImage =
- _dataFromBase64(jsonObject["borderBackgroundImage"]);
- result.helpAnimationImage =
- _dataFromBase64(jsonObject["helpAnimationImage"]);
- result.closeButtonImage = _dataFromBase64(jsonObject["closeButtonImage"]);
- result.captureButtonImage =
- _dataFromBase64(jsonObject["captureButtonImage"]);
- result.cameraSwitchButtonImage =
- _dataFromBase64(jsonObject["cameraSwitchButtonImage"]);
- result.torchButtonOnImage =
- _dataFromBase64(jsonObject["torchButtonOnImage"]);
- result.torchButtonOffImage =
- _dataFromBase64(jsonObject["torchButtonOffImage"]);
- result.changeFrameButtonExpandImage =
- _dataFromBase64(jsonObject["changeFrameButtonExpandImage"]);
- result.changeFrameButtonCollapseImage =
- _dataFromBase64(jsonObject["changeFrameButtonCollapseImage"]);
- result.livenessAnimationImage =
- _dataFromBase64(jsonObject["livenessAnimationImage"]);
-
- result.customLabelStatus = jsonObject["customLabelStatus"];
- result.cameraFrameLineCap =
- Cap.getByValue(jsonObject["cameraFrameLineCap"]);
- result.uiCustomizationLayer = jsonObject["uiCustomizationLayer"];
- result.statusTextFont = Font.fromJson(jsonObject["statusTextFont"]);
- result.resultStatusTextFont =
- Font.fromJson(jsonObject["resultStatusTextFont"]);
-
- result.helpAnimationImageTransformsIOS =
- ViewContentMode.getByValue(jsonObject["helpAnimationImageContentMode"]);
- result.multipageAnimationFrontImageTransformsIOS =
- ViewContentMode.getByValue(
- jsonObject["multipageAnimationFrontImageContentMode"]);
- result.multipageAnimationBackImageTransformsIOS =
- ViewContentMode.getByValue(
- jsonObject["multipageAnimationBackImageContentMode"]);
- result.livenessAnimationImageTransformsIOS = ViewContentMode.getByValue(
- jsonObject["livenessAnimationImageContentMode"]);
- result.borderBackgroundImageTransformsIOS = ViewContentMode.getByValue(
- jsonObject["borderBackgroundImageContentMode"]);
-
- if (jsonObject["helpAnimationImageMatrix"] != null) {
- List<double> array = [];
- for (var value in jsonObject["helpAnimationImageMatrix"])
- array.add(value.toDouble());
- result.helpAnimationImageTransformsAndroid = array;
- } else
- result.helpAnimationImageTransformsAndroid = null;
- if (jsonObject["multipageAnimationFrontImageMatrix"] != null) {
- List<double> array = [];
- for (var value in jsonObject["multipageAnimationFrontImageMatrix"])
- array.add(value.toDouble());
- result.multipageAnimationFrontImageTransformsAndroid = array;
- } else
- result.multipageAnimationFrontImageTransformsAndroid = null;
- if (jsonObject["multipageAnimationBackImageMatrix"] != null) {
- List<double> array = [];
- for (var value in jsonObject["multipageAnimationBackImageMatrix"])
- array.add(value.toDouble());
- result.multipageAnimationBackImageTransformsAndroid = array;
- } else
- result.multipageAnimationBackImageTransformsAndroid = null;
- if (jsonObject["livenessAnimationImageMatrix"] != null) {
- List<double> array = [];
- for (var value in jsonObject["livenessAnimationImageMatrix"])
- array.add(value.toDouble());
- result.livenessAnimationImageTransformsAndroid = array;
- } else
- result.livenessAnimationImageTransformsAndroid = null;
- if (jsonObject["borderBackgroundImageMatrix"] != null) {
- List<double> array = [];
- for (var value in jsonObject["borderBackgroundImageMatrix"])
- array.add(value.toDouble());
- result.borderBackgroundImageTransformsAndroid = array;
- } else
- result.borderBackgroundImageTransformsAndroid = null;
-
- result.colors = CustomizationColors.fromJson(jsonObject["colors"]);
- result.fonts = CustomizationFonts.fromJson(jsonObject["fonts"]);
- result.images = CustomizationImages.fromJson(jsonObject["images"]);
-
- return result;
-}
-Allows you to set any image for the help animation.
-ByteData? get helpAnimationImage => _helpAnimationImage;
-set helpAnimationImage(ByteData? val) {
- _helpAnimationImage = val;
- _set({"helpAnimationImage": _dataToBase64(val)});
-}
-Matrix used to scale help animation.
-Android class android.graphics.Matrix.
-Passed as Matrix.setValues()
Android only. For iOS use helpAnimationImageTransformsIOS.
-List<double>? get helpAnimationImageTransformsAndroid =>
- _helpAnimationImageTransformsAndroid;
-set helpAnimationImageTransformsAndroid(List<double>? val) {
- _helpAnimationImageTransformsAndroid = val;
- _set({"helpAnimationImageMatrix": val});
-}
-Allows you to specify how a view of the help animation adjusts -its content when its size changes.
-Default: ViewContentMode.SCALE_ASPECT_FIT.
-IOS only. For Android use helpAnimationImageTransformsAndroid.
-ViewContentMode? get helpAnimationImageTransformsIOS =>
- _helpAnimationImageTransformsIOS;
-set helpAnimationImageTransformsIOS(ViewContentMode? val) {
- _helpAnimationImageTransformsIOS = val;
- _set({"helpAnimationImageContentMode": val?.value});
-}
-CustomizationImages get images => _images;
-set images(CustomizationImages val) {
- (_images = val)._apply(this);
-}
-Allows you to set any image for the liveness animation.
-When set to null the default image will be used.
-This property can be set during the scanning process to tailor
-the user experiese for different types of documents.
ByteData? get livenessAnimationImage => _livenessAnimationImage;
-set livenessAnimationImage(ByteData? val) {
- _livenessAnimationImage = val;
- _set({"livenessAnimationImage": _dataToBase64(val)});
-}
-Matrix used to scale liveness animation.
-Android class android.graphics.Matrix.
-Passed as Matrix.setValues()
Android only. For iOS use livenessAnimationImageTransformsIOS.
-List<double>? get livenessAnimationImageTransformsAndroid =>
- _livenessAnimationImageTransformsAndroid;
-set livenessAnimationImageTransformsAndroid(List<double>? val) {
- _livenessAnimationImageTransformsAndroid = val;
- _set({"livenessAnimationImageMatrix": val});
-}
-Allows you to specify how a view of the liveness animation -adjusts its content when its size changes.
-Default: ViewContentMode.SCALE_ASPECT_FIT.
-IOS only. For Android use livenessAnimationImageTransformsAndroid.
-ViewContentMode? get livenessAnimationImageTransformsIOS =>
- _livenessAnimationImageTransformsIOS;
-set livenessAnimationImageTransformsIOS(ViewContentMode? val) {
- _livenessAnimationImageTransformsIOS = val;
- _set({"livenessAnimationImageContentMode": val?.value});
-}
-Allows you to change the location of the liveness animation.
-For example, if you set the multiplier to 0.5 and the number of pixels -by vertical is equal to 800, the animation will be centralized and located -at 200 px from the top, i.e. (800 / 2) * 0.5 = 200 px. If the multiplier -is set to 1, the animation will be centered. If the multiplier is -set to 0, the default value will be used.
-Defaults to 1.
-double? get livenessAnimationPositionMultiplier =>
- _livenessAnimationPositionMultiplier;
-set livenessAnimationPositionMultiplier(double? val) {
- _livenessAnimationPositionMultiplier = val;
- _set({"livenessAnimationPositionMultiplier": val});
-}
-Allows you to set any image for the multipage animation (back side).
-ByteData? get multipageAnimationBackImage => _multipageAnimationBackImage;
-set multipageAnimationBackImage(ByteData? val) {
- _multipageAnimationBackImage = val;
- _set({"multipageAnimationBackImage": _dataToBase64(val)});
-}
-Matrix used to scale multipage animation (back side).
-Android class android.graphics.Matrix.
-Passed as Matrix.setValues()
Android only. For iOS use multipageAnimationBackImageTransformsIOS.
-List<double>? get multipageAnimationBackImageTransformsAndroid =>
- _multipageAnimationBackImageTransformsAndroid;
-set multipageAnimationBackImageTransformsAndroid(List<double>? val) {
- _multipageAnimationBackImageTransformsAndroid = val;
- _set({"multipageAnimationBackImageMatrix": val});
-}
-Allows you to specify how a view of the multipage animation (back side) -adjusts its content when its size changes.
-Default: ViewContentMode.SCALE_TO_FILL.
-IOS only. For Android use multipageAnimationBackImageTransformsAndroid.
-ViewContentMode? get multipageAnimationBackImageTransformsIOS =>
- _multipageAnimationBackImageTransformsIOS;
-set multipageAnimationBackImageTransformsIOS(ViewContentMode? val) {
- _multipageAnimationBackImageTransformsIOS = val;
- _set({"multipageAnimationBackImageContentMode": val?.value});
-}
-Allows you to set any image for the multipage animation (front side).
-ByteData? get multipageAnimationFrontImage => _multipageAnimationFrontImage;
-set multipageAnimationFrontImage(ByteData? val) {
- _multipageAnimationFrontImage = val;
- _set({"multipageAnimationFrontImage": _dataToBase64(val)});
-}
-Matrix used to scale multipage animation (front side).
-Android class android.graphics.Matrix.
-Passed as Matrix.setValues()
Android only. For iOS use multipageAnimationFrontImageTransformsIOS.
-List<double>? get multipageAnimationFrontImageTransformsAndroid =>
- _multipageAnimationFrontImageTransformsAndroid;
-set multipageAnimationFrontImageTransformsAndroid(List<double>? val) {
- _multipageAnimationFrontImageTransformsAndroid = val;
- _set({"multipageAnimationFrontImageMatrix": val});
-}
-Allows you to specify how a view of the multipage animation (front side) -adjusts its content when its size changes.
-Default: ViewContentMode.SCALE_TO_FILL.
-IOS only. For Android use multipageAnimationFrontImageTransformsAndroid.
-ViewContentMode? get multipageAnimationFrontImageTransformsIOS =>
- _multipageAnimationFrontImageTransformsIOS;
-set multipageAnimationFrontImageTransformsIOS(ViewContentMode? val) {
- _multipageAnimationFrontImageTransformsIOS = val;
- _set({"multipageAnimationFrontImageContentMode": val?.value});
-}
-Allows you to set a color for the "Skip next page" button.
-Color? get multipageButtonBackgroundColor => _multipageButtonBackgroundColor;
-set multipageButtonBackgroundColor(Color? val) {
- _multipageButtonBackgroundColor = val;
- _set({"multipageButtonBackgroundColor": _intFromColor(val)});
-}
-Allows you to set any string to the result status.
-String? get resultStatus => _resultStatus;
-set resultStatus(String? val) {
- _resultStatus = val;
- _set({"resultStatus": val});
-}
-Allows you to set a color of the background for the result status messages.
-Color? get resultStatusBackgroundColor => _resultStatusBackgroundColor;
-set resultStatusBackgroundColor(Color? val) {
- _resultStatusBackgroundColor = val;
- _set({"resultStatusBackgroundColor": _intFromColor(val)});
-}
-Allows you to change the location of the result status.
-For example, if you set the multiplier to 0.5 and the number of pixels -by vertical is equal to 800, your message will be centralized and located -at 200 px from the top, i.e. (800 / 2) * 0.5 = 200 px. If the multiplier -is equal to 1, the message will be centered. If the multiplier is equal -to zero, the default location will be used.
-Default: 0.
-double? get resultStatusPositionMultiplier => _resultStatusPositionMultiplier;
-set resultStatusPositionMultiplier(double? val) {
- _resultStatusPositionMultiplier = val;
- _set({"resultStatusPositionMultiplier": val});
-}
-Allows you to set a color for the result status messages.
-Default: Colors.white.
-Color? get resultStatusTextColor => _resultStatusTextColor;
-set resultStatusTextColor(Color? val) {
- _resultStatusTextColor = val;
- _set({"resultStatusTextColor": _intFromColor(val)});
-}
-Allows you to set a font for the result status messages.
-Font? get resultStatusTextFont => _resultStatusTextFont;
-set resultStatusTextFont(Font? val) {
- _resultStatusTextFont = val;
- _set({"resultStatusTextFont": val?.toJson()});
-}
-If it's set to true, the background mask next to the camera frame
-will be displayed.
Default: true.
bool? get showBackgroundMask => _showBackgroundMask;
-set showBackgroundMask(bool? val) {
- _showBackgroundMask = val;
- _set({"showBackgroundMask": val});
-}
-If it's set to true, the animation showing how to position a document
-will be displayed.
Default: false.
bool? get showHelpAnimation => _showHelpAnimation;
-set showHelpAnimation(bool? val) {
- _showHelpAnimation = val;
- _set({"showHelpAnimation": val});
-}
-If it's set to true, the animation asking for processing
-the next page will be displayed.
Default: true.
bool? get showNextPageAnimation => _showNextPageAnimation;
-set showNextPageAnimation(bool? val) {
- _showNextPageAnimation = val;
- _set({"showNextPageAnimation": val});
-}
-If it's set to true, result status messages during the document processing
-will be shown.
Default: true.
bool? get showResultStatusMessages => _showResultStatusMessages;
-set showResultStatusMessages(bool? val) {
- _showResultStatusMessages = val;
- _set({"showResultStatusMessages": val});
-}
-If it's set to true, status messages during the document processing
-will be shown.
Default: true.
bool? get showStatusMessages => _showStatusMessages;
-set showStatusMessages(bool? val) {
- _showStatusMessages = val;
- _set({"showStatusMessages": val});
-}
-Allows you to set any string to the status.
-String? get status => _status;
-set status(String? val) {
- _status = val;
- _set({"status": val});
-}
-Allows you to set a background color for the status messages.
-Default: Colors.transparent.
-Color? get statusBackgroundColor => _statusBackgroundColor;
-set statusBackgroundColor(Color? val) {
- _statusBackgroundColor = val;
- _set({"statusBackgroundColor": _intFromColor(val)});
-}
-Allows you to change the location of the status.
-For example, if you set the multiplier to 0.5 and the number of pixels -by vertical is equal to 800, your message will be centralized and located -at 200 px from the top, i.e. (800 / 2) * 0.5 = 200 px. If the multiplier -is equal to 1, the message will be centered. If the multiplier is equal -to zero, the default location will be used.
-Default: 0.
-double? get statusPositionMultiplier => _statusPositionMultiplier;
-set statusPositionMultiplier(double? val) {
- _statusPositionMultiplier = val;
- _set({"statusPositionMultiplier": val});
-}
-Allows you to set a color for the status messages.
-Default: Colors.white.
-Color? get statusTextColor => _statusTextColor;
-set statusTextColor(Color? val) {
- _statusTextColor = val;
- _set({"statusTextColor": _intFromColor(val)});
-}
-Allows you to set a font for the status messages.
-Font? get statusTextFont => _statusTextFont;
-set statusTextFont(Font? val) {
- _statusTextFont = val;
- _set({"statusTextFont": val?.toJson()});
-}
-Allows you to set a color for all visual elements.
-Color? get tintColor => _tintColor;
-set tintColor(Color? val) {
- _tintColor = val;
- _set({"tintColor": _intFromColor(val)});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "showStatusMessages": showStatusMessages,
- "showResultStatusMessages": showResultStatusMessages,
- "showHelpAnimation": showHelpAnimation,
- "showNextPageAnimation": showNextPageAnimation,
- "showBackgroundMask": showBackgroundMask,
- "cameraFrameBorderWidth": cameraFrameBorderWidth,
- "cameraFrameLineLength": cameraFrameLineLength,
- "cameraFrameShapeType": cameraFrameShapeType?.value,
- "cameraFrameOffsetWidth": cameraFrameOffsetWidth,
- "status": status,
- "resultStatus": resultStatus,
- "cameraFrameDefaultColor": _intFromColor(cameraFrameDefaultColor),
- "cameraFrameActiveColor": _intFromColor(cameraFrameActiveColor),
- "statusTextColor": _intFromColor(statusTextColor),
- "resultStatusTextColor": _intFromColor(resultStatusTextColor),
- "resultStatusBackgroundColor":
- _intFromColor(resultStatusBackgroundColor),
- "multipageButtonBackgroundColor":
- _intFromColor(multipageButtonBackgroundColor),
- "tintColor": _intFromColor(tintColor),
- "activityIndicatorColor": _intFromColor(activityIndicatorColor),
- "statusBackgroundColor": _intFromColor(statusBackgroundColor),
- "cameraPreviewBackgroundColor":
- _intFromColor(cameraPreviewBackgroundColor),
- "statusPositionMultiplier": statusPositionMultiplier,
- "resultStatusPositionMultiplier": resultStatusPositionMultiplier,
- "toolbarSize": toolbarSize,
- "backgroundMaskAlpha": backgroundMaskAlpha,
- "customStatusPositionMultiplier": customStatusPositionMultiplier,
- "cameraFrameVerticalPositionMultiplier":
- cameraFrameVerticalPositionMultiplier,
- "cameraFrameLandscapeAspectRatio": cameraFrameLandscapeAspectRatio,
- "cameraFramePortraitAspectRatio": cameraFramePortraitAspectRatio,
- "cameraFrameCornerRadius": cameraFrameCornerRadius,
- "livenessAnimationPositionMultiplier":
- livenessAnimationPositionMultiplier,
- "multipageAnimationFrontImage":
- _dataToBase64(multipageAnimationFrontImage),
- "multipageAnimationBackImage":
- _dataToBase64(multipageAnimationBackImage),
- "borderBackgroundImage": _dataToBase64(borderBackgroundImage),
- "helpAnimationImage": _dataToBase64(helpAnimationImage),
- "closeButtonImage": _dataToBase64(closeButtonImage),
- "captureButtonImage": _dataToBase64(captureButtonImage),
- "cameraSwitchButtonImage": _dataToBase64(cameraSwitchButtonImage),
- "torchButtonOnImage": _dataToBase64(torchButtonOnImage),
- "torchButtonOffImage": _dataToBase64(torchButtonOffImage),
- "changeFrameButtonExpandImage":
- _dataToBase64(changeFrameButtonExpandImage),
- "changeFrameButtonCollapseImage":
- _dataToBase64(changeFrameButtonCollapseImage),
- "livenessAnimationImage": _dataToBase64(livenessAnimationImage),
- "customLabelStatus": customLabelStatus,
- "cameraFrameLineCap": cameraFrameLineCap?.value,
- "uiCustomizationLayer": uiCustomizationLayer,
- "statusTextFont": statusTextFont?.toJson(),
- "resultStatusTextFont": resultStatusTextFont?.toJson(),
- "helpAnimationImageContentMode": helpAnimationImageTransformsIOS?.value,
- "multipageAnimationFrontImageContentMode":
- multipageAnimationFrontImageTransformsIOS?.value,
- "multipageAnimationBackImageContentMode":
- multipageAnimationBackImageTransformsIOS?.value,
- "livenessAnimationImageContentMode":
- livenessAnimationImageTransformsIOS?.value,
- "borderBackgroundImageContentMode":
- borderBackgroundImageTransformsIOS?.value,
- "helpAnimationImageMatrix": helpAnimationImageTransformsAndroid,
- "multipageAnimationFrontImageMatrix":
- multipageAnimationFrontImageTransformsAndroid,
- "multipageAnimationBackImageMatrix":
- multipageAnimationBackImageTransformsAndroid,
- "livenessAnimationImageMatrix": livenessAnimationImageTransformsAndroid,
- "borderBackgroundImageMatrix": borderBackgroundImageTransformsAndroid,
- "colors": colors.toJson(),
- "fonts": fonts.toJson(),
- "images": images.toJson(),
- }.clearNulls();
-Allows you to set a size for the toolbar -(it's where all buttons are located).
-double? get toolbarSize => _toolbarSize;
-set toolbarSize(double? val) {
- _toolbarSize = val;
- _set({"toolbarSize": val});
-}
-Allows you to set any image for the torch button when its state is OFF.
-ByteData? get torchButtonOffImage => _torchButtonOffImage;
-set torchButtonOffImage(ByteData? val) {
- _torchButtonOffImage = val;
- _set({"torchButtonOffImage": _dataToBase64(val)});
-}
-Allows you to set any image for the torch button when its state is ON.
-ByteData? get torchButtonOnImage => _torchButtonOnImage;
-set torchButtonOnImage(ByteData? val) {
- _torchButtonOnImage = val;
- _set({"torchButtonOnImage": _dataToBase64(val)});
-}
-JSON structure defining labels and graphic elements -to be added to the Camera UI
-Map<String, dynamic>? get uiCustomizationLayer => _uiCustomizationLayer;
-set uiCustomizationLayer(Map<String, dynamic>? val) {
- _uiCustomizationLayer = val;
- _set({"uiCustomizationLayer": val});
-}
-Allows you to deserialize object.
-static CustomizationColors fromJson(jsonObject) {
- var result = CustomizationColors();
- result.testSetters = {};
-
- result.rfidProcessingScreenBackground =
- _intToColor(jsonObject["rfidProcessingScreenBackground"])!;
- result.rfidProcessingScreenHintLabelText =
- _intToColor(jsonObject["rfidProcessingScreenHintLabelText"])!;
- result.rfidProcessingScreenHintLabelBackground =
- _intToColor(jsonObject["rfidProcessingScreenHintLabelBackground"])!;
- result.rfidProcessingScreenProgressLabelText =
- _intToColor(jsonObject["rfidProcessingScreenProgressLabelText"])!;
- result.rfidProcessingScreenProgressBar =
- _intToColor(jsonObject["rfidProcessingScreenProgressBar"])!;
- result.rfidProcessingScreenProgressBarBackground =
- _intToColor(jsonObject["rfidProcessingScreenProgressBarBackground"])!;
- result.rfidProcessingScreenResultLabelText =
- _intToColor(jsonObject["rfidProcessingScreenResultLabelText"])!;
-
- return result;
-}
-Color get rfidProcessingScreenBackground => _rfidProcessingScreenBackground;
-set rfidProcessingScreenBackground(Color val) {
- _rfidProcessingScreenBackground = val;
- _set({"rfidProcessingScreenBackground": _intFromColor(val)});
-}
-Color get rfidProcessingScreenHintLabelBackground =>
- _rfidProcessingScreenHintLabelBackground;
-set rfidProcessingScreenHintLabelBackground(Color val) {
- _rfidProcessingScreenHintLabelBackground = val;
- _set({"rfidProcessingScreenHintLabelBackground": _intFromColor(val)});
-}
-Color get rfidProcessingScreenHintLabelText =>
- _rfidProcessingScreenHintLabelText;
-set rfidProcessingScreenHintLabelText(Color val) {
- _rfidProcessingScreenHintLabelText = val;
- _set({"rfidProcessingScreenHintLabelText": _intFromColor(val)});
-}
-Color get rfidProcessingScreenProgressBar => _rfidProcessingScreenProgressBar;
-set rfidProcessingScreenProgressBar(Color val) {
- _rfidProcessingScreenProgressBar = val;
- _set({"rfidProcessingScreenProgressBar": _intFromColor(val)});
-}
-Color get rfidProcessingScreenProgressBarBackground =>
- _rfidProcessingScreenProgressBarBackground;
-set rfidProcessingScreenProgressBarBackground(Color val) {
- _rfidProcessingScreenProgressBarBackground = val;
- _set({"rfidProcessingScreenProgressBarBackground": _intFromColor(val)});
-}
-Color get rfidProcessingScreenProgressLabelText =>
- _rfidProcessingScreenProgressLabelText;
-set rfidProcessingScreenProgressLabelText(Color val) {
- _rfidProcessingScreenProgressLabelText = val;
- _set({"rfidProcessingScreenProgressLabelText": _intFromColor(val)});
-}
-Color get rfidProcessingScreenResultLabelText =>
- _rfidProcessingScreenResultLabelText;
-set rfidProcessingScreenResultLabelText(Color val) {
- _rfidProcessingScreenResultLabelText = val;
- _set({"rfidProcessingScreenResultLabelText": _intFromColor(val)});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "rfidProcessingScreenBackground":
- _intFromColor(rfidProcessingScreenBackground),
- "rfidProcessingScreenHintLabelText":
- _intFromColor(rfidProcessingScreenHintLabelText),
- "rfidProcessingScreenHintLabelBackground":
- _intFromColor(rfidProcessingScreenHintLabelBackground),
- "rfidProcessingScreenProgressLabelText":
- _intFromColor(rfidProcessingScreenProgressLabelText),
- "rfidProcessingScreenProgressBar":
- _intFromColor(rfidProcessingScreenProgressBar),
- "rfidProcessingScreenProgressBarBackground":
- _intFromColor(rfidProcessingScreenProgressBarBackground),
- "rfidProcessingScreenResultLabelText":
- _intFromColor(rfidProcessingScreenResultLabelText),
- }.clearNulls();
-Allows you to deserialize object.
-static CustomizationFonts fromJson(jsonObject) {
- var result = CustomizationFonts();
- result.testSetters = {};
-
- result.rfidProcessingScreenHintLabel =
- Font.fromJson(jsonObject["rfidProcessingScreenHintLabel"]);
- result.rfidProcessingScreenProgressLabel =
- Font.fromJson(jsonObject["rfidProcessingScreenProgressLabel"]);
- result.rfidProcessingScreenResultLabel =
- Font.fromJson(jsonObject["rfidProcessingScreenResultLabel"]);
-
- return result;
-}
-Font? get rfidProcessingScreenHintLabel => _rfidProcessingScreenHintLabel;
-set rfidProcessingScreenHintLabel(Font? val) {
- _rfidProcessingScreenHintLabel = val;
- _set({"rfidProcessingScreenHintLabel": val?.toJson()});
-}
-Font? get rfidProcessingScreenProgressLabel =>
- _rfidProcessingScreenProgressLabel;
-set rfidProcessingScreenProgressLabel(Font? val) {
- _rfidProcessingScreenProgressLabel = val;
- _set({"rfidProcessingScreenProgressLabel": val?.toJson()});
-}
-Font? get rfidProcessingScreenResultLabel => _rfidProcessingScreenResultLabel;
-set rfidProcessingScreenResultLabel(Font? val) {
- _rfidProcessingScreenResultLabel = val;
- _set({"rfidProcessingScreenResultLabel": val?.toJson()});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "rfidProcessingScreenHintLabel":
- rfidProcessingScreenHintLabel?.toJson(),
- "rfidProcessingScreenProgressLabel":
- rfidProcessingScreenProgressLabel?.toJson(),
- "rfidProcessingScreenResultLabel":
- rfidProcessingScreenResultLabel?.toJson(),
- }.clearNulls();
-Allows you to deserialize object.
-static CustomizationImages fromJson(jsonObject) {
- var result = CustomizationImages();
- result.testSetters = {};
-
- result.rfidProcessingScreenFailureImage =
- _dataFromBase64(jsonObject["rfidProcessingScreenFailureImage"])!;
-
- return result;
-}
-ByteData get rfidProcessingScreenFailureImage =>
- _rfidProcessingScreenFailureImage;
-set rfidProcessingScreenFailureImage(ByteData val) {
- _rfidProcessingScreenFailureImage = val;
- _set({"rfidProcessingScreenFailureImage": _dataToBase64(val)});
-}
-String get data => _data;
-RFIDDataFileType get fieldType => _fieldType;
-Allows you to deserialize object.
-static DataField? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = DataField();
-
- result._data = jsonObject["data"];
- var fieldType = RFIDDataFileType.getByValue(jsonObject["fieldType"]);
- if (fieldType == null) return null;
- result._fieldType = fieldType;
-
- return result;
-}
-Defining the geometric format of documents in accordance with ISO / IEC 7810.
-Unknown format.
- - -DocFormat(-1)
- ID1 document format.
- - -DocFormat(0)
- ID2 document format.
- - -DocFormat(1)
- ID3 document format.
- - -DocFormat(2)
- Undefined document format.
- - -DocFormat(3)
- A4 document format.
- - -DocFormat(4)
- ID3 double document format.
- - -DocFormat(5)
- ID2 Turkey document format.
- - -DocFormat(6)
- ID1 format document rotated 90 degrees.
- - -DocFormat(10)
- ID1 format document rotated 180 degrees.
- - -DocFormat(11)
- ID1 format document rotated 270 degrees.
- - -DocFormat(12)
- ID2 format document rotated 180 degrees.
- - -DocFormat(13)
- ID3 format document rotated 180 degrees.
- - -DocFormat(14)
- Arbitrary format.
- - -DocFormat(1000)
- Photo format.
- - -DocFormat(1001)
- Flexible format. Standard formats can be resized during cropping, depending -on various factors: light, background etc.
- - -DocFormat(1002)
- const DocFormat
-final int value;
-Contains all possible DocumentReaderNotification callback codes
-Processing finished, the results were received
- - -DocReaderAction(0)
- Processing didn't finish, intermediate results may be obtained
- - -DocReaderAction(1)
- Processing of a page is completed, the next one can be processed
- - -DocReaderAction(2)
- Processing was cancelled, incomplete results may be obtained
- - -DocReaderAction(3)
- An error occurred during processing, incomplete results may be obtained
- - -DocReaderAction(4)
- Processing of a hologram is started
- - -DocReaderAction(5)
- Processing is finished by timeout, intermediate results can be received. Processing finishes due to non-compliance with the image quality requirements
- - -DocReaderAction(6)
- Online processing is started
- - -DocReaderAction(7)
- Processing didn't finish, intermediate results may be obtained, UV images may be obtained
- - -DocReaderAction(102)
- Processing didn't finish, intermediate results may be obtained, IR images may be obtained
- - -DocReaderAction(103)
- [COMPLETE, PROCESS, MORE_PAGES_AVAILABLE, CANCEL, ERROR, PROCESS_WHITE_FLASHLIGHT, TIMEOUT, PROCESSING_ON_SERVICE, PROCESS_WHITE_UV_IMAGES, PROCESS_IR_FRAME]
- const DocReaderAction
-bool finished() => this == COMPLETE || this == TIMEOUT;
-bool interrupted() => this == CANCEL || this == ERROR;
-bool stopped() => finished() || interrupted();
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-ErrorCodes get code => _code;
-@visibleForTesting
-static DocReaderException? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = DocReaderException();
-
- result._code = ErrorCodes.getByValue(jsonObject["code"])!;
- result._message = jsonObject["message"] ?? "";
-
- return result;
-}
-String get message => _message;
-Will be returned if getByValue if a non-existent was passed.
- - -DocReaderFrame("")
- Size of the frame depends on the scenario, that means default values are used.
- - -DocReaderFrame("id1")
- Full frame.
- - -DocReaderFrame("max")
- No frame.
- - -DocReaderFrame("none")
- Size of the frame corresponds to the ID-3 format in the portrait mode -and to the ID-1 in the landscape mode.
- - -DocReaderFrame("document")
- [UNKNOWN, SCENARIO_DEFAULT, MAX, NONE, DOCUMENT]
- const DocReaderFrame
-final String value;
-A constant List of the values in this enum, in order of their declaration.
-Contains set of values of the application's orientation.
-Will be returned if getByValue if a non-existent was passed.
- - -DocReaderOrientation(-1)
- All interface orientations - orientation not set, activities will rotate.
- - -DocReaderOrientation(0)
- A portrait interface orientation.
- - -DocReaderOrientation(1)
- Both landscape-left and landscape-right interface orientation.
- - -DocReaderOrientation(2)
- A landscape-left interface orientation.
- - -DocReaderOrientation(3)
- A landscape-right interface orientation.
- - -DocReaderOrientation(4)
- [UNKNOWN, ALL, PORTRAIT, LANDSCAPE, LANDSCAPE_LEFT, LANDSCAPE_RIGHT]
- const DocReaderOrientation
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-string representation of scenario ID.
-String get caption => _caption;
-Description of the scenario.
-String get description => _description;
-bool get faceExt => _faceExt;
-double get frameKWHDoublePageSpreadLandscape =>
- _frameKWHDoublePageSpreadLandscape;
-double get frameKWHDoublePageSpreadPortrait =>
- _frameKWHDoublePageSpreadPortrait;
-double get frameKWHLandscape => _frameKWHLandscape;
-double get frameKWHPortrait => _frameKWHPortrait;
-Available orientation for scenario.
-DocReaderOrientation get frameOrientation => _frameOrientation;
-@visibleForTesting
-static DocReaderScenario? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = DocReaderScenario();
-
- result._uvTorch = jsonObject["uvTorch"];
- result._frameOrientation =
- DocReaderOrientation.getByValue(jsonObject["frameOrientation"])!;
- result._faceExt = jsonObject["faceExt"];
- result._multiPageOff = jsonObject["multiPageOff"];
- result._seriesProcessMode = jsonObject["seriesProcessMode"];
- result._frameKWHLandscape = jsonObject["frameKWHLandscape"].toDouble();
- result._frameKWHPortrait = jsonObject["frameKWHPortrait"].toDouble();
- result._frameKWHDoublePageSpreadPortrait =
- jsonObject["frameKWHDoublePageSpreadPortrait"].toDouble();
- result._frameKWHDoublePageSpreadLandscape =
- jsonObject["frameKWHDoublePageSpreadLandscape"].toDouble();
- result._name = jsonObject["name"];
- result._caption = jsonObject["caption"];
- result._description = jsonObject["description"];
- result._manualCrop = jsonObject["manualCrop"];
-
- return result;
-}
-bool get manualCrop => _manualCrop;
-bool get multiPageOff => _multiPageOff;
-ID of the scenario.
-String get name => _name;
-bool get seriesProcessMode => _seriesProcessMode;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "uvTorch": uvTorch,
- "frameOrientation": frameOrientation.value,
- "faceExt": faceExt,
- "multiPageOff": multiPageOff,
- "seriesProcessMode": seriesProcessMode,
- "frameKWHLandscape": frameKWHLandscape,
- "frameKWHPortrait": frameKWHPortrait,
- "frameKWHDoublePageSpreadPortrait": frameKWHDoublePageSpreadPortrait,
- "frameKWHDoublePageSpreadLandscape": frameKWHDoublePageSpreadLandscape,
- "name": name,
- "caption": caption,
- "description": description,
- "manualCrop": manualCrop
- }.clearNulls();
-bool get uvTorch => _uvTorch;
-Class contains properties to get the information about the SDK.
-A version of the API framework.
-String? get api => _api;
-A version of the Core framework.
-String? get core => _core;
-A type of the Core framework.
-String? get coreMode => _coreMode;
-A version of the database.
-DocumentsDatabase? get database => _database;
-@visibleForTesting
-static DocReaderVersion? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = DocReaderVersion();
-
- result._api = jsonObject["api"];
- result._core = jsonObject["core"];
- result._coreMode = jsonObject["coreMode"];
- result._database = DocumentsDatabase.fromJson(jsonObject["database"]);
-
- return result;
-}
-An unknown document type.
- - -DocType(0)
- Passport.
- - -DocType(11)
- Identity Card.
- - -DocType(12)
- Diplomatic Passport.
- - -DocType(13)
- Service Passport.
- - -DocType(14)
- Seaman's Identity Document.
- - -DocType(15)
- Identity Card for Residence.
- - -DocType(16)
- Travel Document.
- - -DocType(17)
- Other.
- - -DocType(99)
- Visa ID-2.
- - -DocType(29)
- Visa ID-3.
- - -DocType(30)
- National Identity Card.
- - -DocType(20)
- Social Identity Card.
- - -DocType(21)
- Alien's Identity Card.
- - -DocType(22)
- Privileged Identity Card.
- - -DocType(23)
- Residence Permit Identity Card.
- - -DocType(24)
- Origin Card.
- - -DocType(25)
- Emergency Passport.
- - -DocType(26)
- Alien's Passport.
- - -DocType(27)
- Alternative Identity Card.
- - -DocType(28)
- Authorization Card.
- - -DocType(32)
- Beginner Permit.
- - -DocType(33)
- Border Crossing Card.
- - -DocType(34)
- Chauffeur License.
- - -DocType(35)
- Chauffeur License under 18.
- - -DocType(36)
- Chauffeur License under 21.
- - -DocType(37)
- Commercial Driving License.
- - -DocType(38)
- Commercial Driving License Instructional Permit.
- - -DocType(39)
- Commercial Driving License under 18.
- - -DocType(40)
- Commercial Driving License under 21.
- - -DocType(41)
- Commercial Indtuction Permit.
- - -DocType(42)
- Commercial New Permit.
- - -DocType(43)
- Concealed Carry License.
- - -DocType(44)
- Concealed Firearm Permit.
- - -DocType(45)
- Conditional Driving License.
- - -DocType(46)
- Department of Veterans Affairs Identity Card.
- - -DocType(47)
- Diplomatic Driving License.
- - -DocType(48)
- Driving License.
- - -DocType(49)
- Driving License Instructional Permit.
- - -DocType(50)
- Driving License Instructional Permit under 18.
- - -DocType(51)
- Driving License Instructional Permit under 21.
- - -DocType(52)
- Driving License Learners Permit.
- - -DocType(53)
- Driving License Learners Permit under 18.
- - -DocType(54)
- Driving License Learners Permit under 21.
- - -DocType(55)
- Driving License Novice.
- - -DocType(56)
- Driving License Novice under 18.
- - -DocType(57)
- Driving License Novice under 21.
- - -DocType(58)
- Driving License Registered Offender.
- - -DocType(59)
- Driving License Redticted under 18.
- - -DocType(60)
- Driving License Redticted under 21.
- - -DocType(61)
- Driving License Temporary Visitor.
- - -DocType(62)
- Driving License Temporary Visitor under 18.
- - -DocType(63)
- Driving License Temporary Visitor under 21.
- - -DocType(64)
- Driving License under 18.
- - -DocType(65)
- Driving License under 21.
- - -DocType(66)
- Employment Driving Permit.
- - -DocType(67)
- Enhanced Chauffeur License.
- - -DocType(68)
- Enhanced Chauffeur License under 18.
- - -DocType(69)
- Enhanced Chauffeur License under 21.
- - -DocType(70)
- Enhanced Commercial Driving License.
- - -DocType(71)
- Enhanced Driving License.
- - -DocType(72)
- Enhanced Driving License under 18.
- - -DocType(73)
- Enhanced Driving License under 21.
- - -DocType(74)
- Enhanced Identity Card.
- - -DocType(75)
- Enhanced Identity Card under 18.
- - -DocType(76)
- Enhanced Identity Card under 21.
- - -DocType(77)
- Enhanced Operators License.
- - -DocType(78)
- Firearms Permit.
- - -DocType(79)
- Full Provisional License.
- - -DocType(80)
- Full Provisional License under 18.
- - -DocType(81)
- Full Provisional License under 21.
- - -DocType(82)
- Geneva Conventions Identity Card.
- - -DocType(83)
- Graduated Driving License under 18.
- - -DocType(84)
- Graduated Driving License under 21.
- - -DocType(85)
- Graduated Indtuction Permit under 18.
- - -DocType(86)
- Graduated Indtuction Permit under 21.
- - -DocType(87)
- Graduated License under 18.
- - -DocType(88)
- Graduated License under 21.
- - -DocType(89)
- Handgun Carry Permit.
- - -DocType(90)
- Identity and Privilege Card.
- - -DocType(91)
- Identity Card Mobility Impaired.
- - -DocType(92)
- Identity Card Registered Offender.
- - -DocType(93)
- Identity Card Temporary Visitor.
- - -DocType(94)
- Identity Card Temporary Visitor under 18.
- - -DocType(95)
- Identity Card Temporary Visitor under 21.
- - -DocType(96)
- Identity Card under 18.
- - -DocType(97)
- Identity Card under 21.
- - -DocType(98)
- Ignition Interlock Permit.
- - -DocType(100)
- Immigrant Visa.
- - -DocType(101)
- Indtuction Permit.
- - -DocType(102)
- Indtuction Permit under 18.
- - -DocType(103)
- Indtuction Permit under 21.
- - -DocType(104)
- Interim Driving License.
- - -DocType(105)
- Interim Identity Card.
- - -DocType(106)
- Intermediate Driving License.
- - -DocType(107)
- Intermediate Driving License under 18.
- - -DocType(108)
- Intermediate Driving License under 21.
- - -DocType(109)
- Junior Driving License.
- - -DocType(110)
- Learner Instructional Permit.
- - -DocType(111)
- Learner License.
- - -DocType(112)
- Learner License under 18.
- - -DocType(113)
- Learner License under 21.
- - -DocType(114)
- Learner Permit.
- - -DocType(115)
- Learner Permit under 18.
- - -DocType(116)
- Learner Permit under 21.
- - -DocType(117)
- Limited License.
- - -DocType(118)
- Limited Permit.
- - -DocType(119)
- Limited Term Driving License.
- - -DocType(120)
- Limited Term Identity Card.
- - -DocType(121)
- Liquor Identity Card.
- - -DocType(122)
- New Permit.
- - -DocType(123)
- New Permit under 18.
- - -DocType(124)
- New Permit under 21.
- - -DocType(125)
- Non-US Citizen Driving License.
- - -DocType(126)
- Occupational Driving License.
- - -DocType(127)
- Oneida Tribe of Indians Identity Card.
- - -DocType(128)
- Operator License.
- - -DocType(129)
- Operator License under 18.
- - -DocType(130)
- Operator License under 21.
- - -DocType(131)
- Permanent Driving License.
- - -DocType(132)
- Permit to Re-enter.
- - -DocType(133)
- Probationary Auto License.
- - -DocType(134)
- Probationary Auto License under 18.
- - -DocType(135)
- Probationary Auto License under 21.
- - -DocType(136)
- Probationary Vehicle Salesperson License.
- - -DocType(137)
- Provisional Driving License.
- - -DocType(138)
- Provisional Driving License under 18.
- - -DocType(139)
- Provisional Driving License under 21.
- - -DocType(140)
- Provisional License.
- - -DocType(141)
- Provisional License under 18.
- - -DocType(142)
- Provisional License under 21.
- - -DocType(143)
- Public Passenger Chauffeur License.
- - -DocType(144)
- Racing and Gaming Comission Card.
- - -DocType(145)
- Refugee Travel Document.
- - -DocType(146)
- Renewal Permit.
- - -DocType(147)
- Restricted Commercial Driving License.
- - -DocType(148)
- Restricted Driving License.
- - -DocType(149)
- Restricted Permit.
- - -DocType(150)
- Seasonal Permit.
- - -DocType(151)
- Seasonal Resident Identity Card.
- - -DocType(152)
- Senior Citizen Identity Card.
- - -DocType(153)
- Sex Offender.
- - -DocType(154)
- Social Security Card.
- - -DocType(155)
- Temporary Driving License.
- - -DocType(156)
- Temporary Driving License under 18.
- - -DocType(157)
- Temporary Driving License under 21.
- - -DocType(158)
- Temporary Identity Card.
- - -DocType(159)
- Temporary Instruction Permit Identity Card.
- - -DocType(160)
- Temporary Instruction Permit Identity Card under 18.
- - -DocType(161)
- Temporary Instruction Permit Identity Card under 21.
- - -DocType(162)
- Temporary Visitor Driving License.
- - -DocType(163)
- Temporary Visitor Driving License under 18.
- - -DocType(164)
- Temporary Visitor Driving License under 21.
- - -DocType(165)
- Uniformed Services Identity Card.
- - -DocType(166)
- Vehicle Salesperson License.
- - -DocType(167)
- Worker Identification Credential.
- - -DocType(168)
- Commercial Driving License Novice.
- - -DocType(169)
- Commercial Driving License Novice under 18.
- - -DocType(170)
- Commercial Driving License Novice under 21.
- - -DocType(171)
- Passport Card.
- - -DocType(172)
- Permanent Resident Card.
- - -DocType(173)
- Personal Identification Verification.
- - -DocType(174)
- Temporary Operator License.
- - -DocType(175)
- Driving License under 19.
- - -DocType(176)
- Identity Card under 19.
- - -DocType(177)
- Visa.
- - -DocType(178)
- Temporary Passport.
- - -DocType(179)
- Voting Card.
- - -DocType(180)
- Health Card.
- - -DocType(181)
- Certificate of Citizenship.
- - -DocType(182)
- Address Card.
- - -DocType(183)
- Airport Immigration Card.
- - -DocType(184)
- Alien Regidtation Card.
- - -DocType(185)
- APEH Card.
- - -DocType(186)
- Coupon To Driving License.
- - -DocType(187)
- Crew Member Certificate.
- - -DocType(188)
- Document for Return.
- - -DocType(189)
- E-Card.
- - -DocType(190)
- Employment Card.
- - -DocType(191)
- HKSAR Immigration Form.
- - -DocType(192)
- Immigrant Card.
- - -DocType(193)
- Labour Card.
- - -DocType(194)
- Laissez Passer.
- - -DocType(195)
- Lawyer Identity Certificate.
- - -DocType(196)
- License Card.
- - -DocType(197)
- Passport Stateless.
- - -DocType(198)
- Passport Child.
- - -DocType(199)
- Passport Consular.
- - -DocType(200)
- Passport Diplomatic Service.
- - -DocType(201)
- Passport Official.
- - -DocType(202)
- Passport Provisional.
- - -DocType(203)
- Passport Special.
- - -DocType(204)
- Permission to the Local Border Traffic.
- - -DocType(205)
- Registration Certificate.
- - -DocType(206)
- SEDESOL Card.
- - -DocType(207)
- Social Card.
- - -DocType(208)
- TB Card.
- - -DocType(209)
- Vehicle Passport.
- - -DocType(210)
- W Document.
- - -DocType(211)
- Diplomatic Identity Card.
- - -DocType(212)
- Consular Identity Card.
- - -DocType(213)
- Income Tax Card.
- - -DocType(214)
- Residence Permit.
- - -DocType(215)
- Document of Identity.
- - -DocType(216)
- Border Crossing Permit.
- - -DocType(217)
- Passport Limited Validity.
- - -DocType(218)
- SIM Card.
- - -DocType(219)
- Tax Card.
- - -DocType(220)
- Company Card.
- - -DocType(221)
- Domestic Passport.
- - -DocType(222)
- Identity Certificate.
- - -DocType(223)
- Resident Id Card.
- - -DocType(224)
- Armed Forces Identity Card.
- - -DocType(225)
- Professional Card.
- - -DocType(226)
- Registration Stamp.
- - -DocType(227)
- Driver Card.
- - -DocType(228)
- Driver Training Certificate.
- - -DocType(229)
- Qualification Driving License.
- - -DocType(230)
- Membership Card.
- - -DocType(231)
- Public Vehicle Driver Authority Card.
- - -DocType(232)
- Marine License.
- - -DocType(233)
- Temporary Learner Driving License.
- - -DocType(234)
- Temporary Commercial Driving License.
- - -DocType(235)
- Interim Instructional Permit.
- - -DocType(236)
- Certificate of Competency.
- - -DocType(237)
- Certificate of Proficiency.
- - -DocType(238)
- DocType(239)
- DocType(240)
- DocType(241)
- DocType(242)
- [NotDefined, Passport, IdentityCard, DiplomaticPassport, ServicePassport, SeamanIdentityDocument, IdentityCardForResidence, TravelDocument, Other, VisaID2, VisaID3, NationalIdentityCard, SocialIdentit…
- const DocType
-final int value;
-Entry point of the Regula DocumentReader SDK.
-TCCParams to the RFID session.
-The parameters are required to be set before starting RFID session.
-
-
-Used to pass certificates to Document Reader that will be used during the -RFID chip processing.
-certificates - PKD certificates.
Future<void> addPKDCertificates(List<PKDCertificate> certificates) async {
- List<dynamic> json = [];
- for (PKDCertificate cert in certificates) {
- json.add(cert.toJson());
- }
- await _bridge.invokeMethod("addPKDCertificates", [json]);
-}
-A list of scenarios that can be used for documents recognition based on -your license and Core framework capabilities.
-List<DocReaderScenario> get availableScenarios => _availableScenarios;
-Allows you to to check database update.
-databaseID - identifier of the database.
Future<DocumentsDatabase?> checkDatabaseUpdate(String databaseID) async {
- String? response = await _bridge.invokeMethod(
- "checkDatabaseUpdate",
- [databaseID],
- );
- return DocumentsDatabase.fromJson(_decode(response));
-}
-It's used to remove certificates from your app that are used during the -RFID chip processing.
-Future<void> clearPKDCertificates() async {
- await _bridge.invokeMethod("clearPKDCertificates", []);
-}
-Params that relate to the camera view controller customization and etc.
-Customization get customization => _customization;
-set customization(Customization val) {
- _customization = val;
- _customization._apply();
-}
-Used to deinitialize Document Reader and free up RAM as a -consequence of this.
-Future<void> deinitializeReader() async {
- await _bridge.invokeMethod("deinitializeReader", []);
-}
-Future<FinalizePackageCompletion> finalizePackage() async {
- var response = await _bridge.invokeMethod("finalizePackage", []);
-
- var jsonObject = json.decode(response);
- var action = DocReaderAction.getByValue(jsonObject["action"])!;
- var info = TransactionInfo.fromJson(jsonObject["info"]);
- var error = DocReaderException.fromJson(jsonObject["error"]);
-
- return (action, info, error);
-}
-Params that influence the scanning process, camera view controller -customization and etc.
-Functionality get functionality => _functionality;
-set functionality(Functionality val) {
- _functionality = val;
- _functionality._apply();
-}
-Allows you to initialize Document Reader.
-config - configuration file for DocumentReader initialization.
Check out SuccessOrError documentation for handling return type.
Future<SuccessOrError> initializeReader(InitConfig config) async {
- var funcName = config._useBleDevice
- ? "initializeReaderWithBleDeviceConfig"
- : "initializeReader";
- var response = await _bridge.invokeMethod(funcName, [config.toJson()]);
- await _onInit();
- return _successOrErrorFromJson(response);
-}
-The only instanse of singleton class DocumentReader.
-static DocumentReader get instance => _instance;
-Allows you to check if you can use external Regula Bluetooth devices based -on your license and Core framework capabilities.
-Android only.
-Future<bool> get isAuthenticatorAvailableForUse async {
- return await _bridge.invokeMethod("isAuthenticatorAvailableForUse", []);
-}
-Checks if the app has all the required bluetooth permissions.
-Android only.
-Future<bool> get isBlePermissionsGranted async {
- if (!Platform.isAndroid)
- throw PlatformException(
- code: "android-only",
- message: "isBlePermissionsGranted is accessible only on Android",
- );
- return await _bridge.invokeMethod("isBlePermissionsGranted", []);
-}
-Allows you to check if RFID chip reading can be performed based on your -license and Core framework capabilities.
-bool get isRFIDAvailableForUse => _isRFIDAvailableForUse;
-Information about your license.
-License get license => _license;
-A localization dictionary to override default localization logic. -Allows to replace any string of DocumentReader SDK with an arbitrary string.
-To see all the localization keys, look up the RegulaSDK.strings file at
-ios/Pods/DocumentReader/DocumentReader.xcframework/ios-arm64/DocumentReader.framework/en.lproj/RegulaSDK.strings.
Map<String, String>? get localizationDictionary => _localizationDictionary;
-set localizationDictionary(Map<String, String>? val) {
- _localizationDictionary = val;
- _setLocalizationDictionary(val);
-}
-set onCustomButtonTapped(CustomButtonTappedCompletion completion) =>
- _setCustomButtonTappedCompletion(completion);
-Allows you to download a database from the Regula server. If it exists -in your app and compatible with the SDK, it won't be downloaded.
-databaseID - identifier of the database.
prepareCompletion - callback that returns downloading progress.
Check out SuccessOrError documentation for handling return type.
Future<SuccessOrError> prepareDatabase(
- String databaseID,
- DocumentReaderPrepareCompletion prepareCompletion,
-) async {
- _setDocumentReaderPrepareCompletion(prepareCompletion);
- var response = await _bridge.invokeMethod("prepareDatabase", [databaseID]);
- return _successOrErrorFromJson(response);
-}
-Params that influence the scanning process.
-ProcessParams get processParams => _processParams;
-set processParams(ProcessParams val) {
- _processParams = val;
- _processParams._apply();
-}
-Used for proccessing predefined images.
-config - scanning configuration.
completion - block to execute after the recognition process finishes.
void recognize(RecognizeConfig config, DocumentReaderCompletion completion) {
- _setDocumentReaderCompletion(completion);
- _bridge.invokeMethod("recognize", [config.toJson()]);
-}
-Use this method to reset all parameters to their default values.
-void resetConfiguration() {
- _bridge.invokeMethod("resetConfiguration", []);
- _functionality = Functionality();
- _processParams = ProcessParams();
- _customization = Customization();
- _rfidScenario = RFIDScenario();
-}
-Used for the RFID chip processing.
-config - chip reading configuration.
void rfid(RFIDConfig config) {
- config._disableUI
- ? _setRFIDCompletion(config._rfidCompletion!)
- : _setDocumentReaderCompletion(config._completion!);
-
- _setRFIDProgressCompletion(config.onProgress);
- _setChipDetectedCompletion(config.onChipDetected);
- _setRetryReadChipCompletion(config.onRetryReadChip);
-
- _setPaCertificateCompletion(config.onRequestPACertificates);
- _setTaCertificateCompletion(config.onRequestTACertificates);
- _setTaSignatureCompletion(config.onRequestTASignature);
-
- _bridge.invokeMethod(config._disableUI ? "readRFID" : "startRFIDReader", [
- config.onRequestPACertificates != null,
- config.onRequestTACertificates != null,
- config.onRequestTASignature != null,
- ]);
-}
-Params that influence the RFID chip processing.
-RFIDScenario get rfidScenario => _rfidScenario;
-set rfidScenario(RFIDScenario val) {
- _rfidScenario = val;
- _rfidScenario._apply();
-}
-Allows you to get a status of the RFID chip reading process.
-IOS only.
-String? get rfidSessionStatus {
- if (!Platform.isIOS)
- throw PlatformException(
- code: "ios-only",
- message: "rfidSessionStatus is accessible only on iOS",
- );
- return _rfidSessionStatus;
-}
-set rfidSessionStatus(String? val) {
- if (!Platform.isIOS)
- throw PlatformException(
- code: "ios-only",
- message: "rfidSessionStatus is accessible only on iOS",
- );
- _rfidSessionStatus = val;
- _setRfidSessionStatus(val);
-}
-Allows you to download a database from the Regula server. -Each new update of the database will be downloaded.
-databaseID - identifier of the database.
prepareCompletion - callback that returns downloading progress.
Check out SuccessOrError documentation for handling return type.
Future<SuccessOrError> runAutoUpdate(
- String databaseID,
- DocumentReaderPrepareCompletion prepareCompletion,
-) async {
- _setDocumentReaderPrepareCompletion(prepareCompletion);
- var response = await _bridge.invokeMethod("runAutoUpdate", [databaseID]);
- return _successOrErrorFromJson(response);
-}
-Used for multiple frames processing which are captured from the camera.
-config - scanning configuration.
completion - block to execute after the recognition process finishes.
void scan(ScannerConfig config, DocumentReaderCompletion completion) {
- _setDocumentReaderCompletion(completion);
- _bridge.invokeMethod("scan", [config.toJson()]);
-}
-Sets the given TCCParams to the RFID session.
-The parameters are required to be set before starting RFID session.
params - TCC related parameters.
Check out SuccessOrError documentation for handling return type.
Future<SuccessOrError> setTCCParams(TccParams params) async {
- var response = await _bridge.invokeMethod(
- "setTCCParams",
- [params.toJson()],
- );
- return _successOrErrorFromJson(response);
-}
-Used to connect to the ble device.
-Android only.
-void startBluetoothService(BluetoothServiceCompletion completion) {
- if (!Platform.isAndroid)
- throw PlatformException(
- code: "android-only",
- message: "startBluetoothService is accessible only on Android",
- );
- _setBluetoothServiceCompletion(completion);
- _bridge.invokeMethod("startBluetoothService", []);
-}
-Used to start the processing of the next page of the document once the -current one is processed.
-Future<void> startNewPage() async {
- await _bridge.invokeMethod("startNewPage", []);
-}
-Used to start a scanning process.
-Future<void> startNewSession() async {
- await _bridge.invokeMethod("startNewSession", []);
-}
-Used to stop the scanning process.
-Future<void> stopRFIDReader() async {
- await _bridge.invokeMethod("stopRFIDReader", []);
-}
-Used to stop the scanning process.
-Future<void> stopScanner() async {
- await _bridge.invokeMethod("stopScanner", []);
-}
-Information about the SDK.
-DocReaderVersion get version => _version;
-Allows user to receive a video file of current session
-set videoEncoderCompletion(VideoEncoderCompletion completion) =>
- _setVideoEncoderCompletion(completion);
-Callback for receiving answer from processing engine.
-action defines current processing status.
results defines current processing results.
error in case of anything is wrong - brief message for developer, null otherwise.
typedef DocumentReaderCompletion = void Function(
- DocReaderAction action,
- Results? results,
- DocReaderException? error,
-);
-Callback for receiving notifications on Documents Database preparation.
-typedef DocumentReaderPrepareCompletion = void Function(
- PrepareProgress progress,
-);
-Document issuing country name.
-String? get countryName => _countryName;
-Document description text.
-String? get description => _description;
-Document format.
-DocFormat get format => _format;
-Allows you to deserialize object.
-static DocumentType? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = DocumentType();
-
- result._pageIndex = jsonObject["pageIndex"];
- result._id = jsonObject["documentID"];
- result._type = DocType.getByValue(jsonObject["dType"])!;
- result._format = DocFormat.getByValue(jsonObject["dFormat"])!;
- result._mrz = jsonObject["dMRZ"];
- result._isDeprecated = jsonObject["isDeprecated"];
- result._name = jsonObject["name"];
- result._iCAOCode = jsonObject["ICAOCode"];
- result._description = jsonObject["dDescription"];
- result._year = jsonObject["dYear"];
- result._countryName = jsonObject["dCountryName"];
- result._fDSID = jsonObject["FDSID"] == null
- ? null
- : List<int>.from(jsonObject["FDSID"]);
-
- return result;
-}
-Document issuing country ICAO code.
-String? get iCAOCode => _iCAOCode;
-Document type numeric code.
-int get id => _id;
-Document deprecation.
-bool get isDeprecated => _isDeprecated;
-Flag for MRZ presence on a document.
-bool get mrz => _mrz;
-Document type name.
-String? get name => _name;
-An index of the document page whence results are received.
-int get pageIndex => _pageIndex;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "name": name,
- "documentID": id,
- "ICAOCode": iCAOCode,
- "FDSID": fDSID,
- "dType": type.value,
- "dFormat": format.value,
- "dMRZ": mrz,
- "isDeprecated": isDeprecated,
- "dDescription": description,
- "dYear": year,
- "dCountryName": countryName,
- "pageIndex": pageIndex,
- }.clearNulls();
-Document type.
-DocType get type => _type;
-Document issue year.
-String? get year => _year;
-Class contains properties to get the information about the database.
-A number of countries included in the database.
-int get countriesNumber => _countriesNumber;
-A list of supported documents in the database.
-String? get databaseDescription => _databaseDescription;
-An ID of the database, e.g. BLR, RUS.
-String? get databaseID => _databaseID;
-A date when the database was created.
-String? get date => _date;
-A number of documents included in the database.
-int get documentsNumber => _documentsNumber;
-@visibleForTesting
-static DocumentsDatabase? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = DocumentsDatabase();
-
- result._databaseID = jsonObject["databaseID"];
- result._version = jsonObject["version"];
- result._date = jsonObject["date"];
- result._databaseDescription = jsonObject["databaseDescription"];
- result._countriesNumber = jsonObject["countriesNumber"];
- result._documentsNumber = jsonObject["documentsNumber"];
- result._size = jsonObject["size"];
-
- return result;
-}
-Database size. In bytes. -Available for database update check.
-int? get size => _size;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "databaseID": databaseID,
- "version": version,
- "date": date,
- "databaseDescription": databaseDescription,
- "countriesNumber": countriesNumber,
- "documentsNumber": documentsNumber,
- "size": size
- }.clearNulls();
-A version of the database.
-String? get version => _version;
-Allows you to deserialize object.
-static EDLDataGroups fromJson(jsonObject) {
- var result = EDLDataGroups();
- result.testSetters = {};
-
- result.dg1 = jsonObject["DG1"];
- result.dg2 = jsonObject["DG2"];
- result.dg3 = jsonObject["DG3"];
- result.dg4 = jsonObject["DG4"];
- result.dg5 = jsonObject["DG5"];
- result.dg6 = jsonObject["DG6"];
- result.dg7 = jsonObject["DG7"];
- result.dg8 = jsonObject["DG8"];
- result.dg9 = jsonObject["DG9"];
- result.dg10 = jsonObject["DG10"];
- result.dg11 = jsonObject["DG11"];
- result.dg12 = jsonObject["DG12"];
- result.dg13 = jsonObject["DG13"];
- result.dg14 = jsonObject["DG14"];
-
- return result;
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "DG1": dg1,
- "DG2": dg2,
- "DG3": dg3,
- "DG4": dg4,
- "DG5": dg5,
- "DG6": dg6,
- "DG7": dg7,
- "DG8": dg8,
- "DG9": dg9,
- "DG10": dg10,
- "DG11": dg11,
- "DG12": dg12,
- "DG13": dg13,
- "DG14": dg14,
- }.clearNulls();
-Allows you to deserialize object.
-static EIDDataGroups fromJson(jsonObject) {
- var result = EIDDataGroups();
- result.testSetters = {};
-
- result.dg1 = jsonObject["DG1"];
- result.dg2 = jsonObject["DG2"];
- result.dg3 = jsonObject["DG3"];
- result.dg4 = jsonObject["DG4"];
- result.dg5 = jsonObject["DG5"];
- result.dg6 = jsonObject["DG6"];
- result.dg7 = jsonObject["DG7"];
- result.dg8 = jsonObject["DG8"];
- result.dg9 = jsonObject["DG9"];
- result.dg10 = jsonObject["DG10"];
- result.dg11 = jsonObject["DG11"];
- result.dg12 = jsonObject["DG12"];
- result.dg13 = jsonObject["DG13"];
- result.dg14 = jsonObject["DG14"];
- result.dg15 = jsonObject["DG15"];
- result.dg16 = jsonObject["DG16"];
- result.dg17 = jsonObject["DG17"];
- result.dg18 = jsonObject["DG18"];
- result.dg19 = jsonObject["DG19"];
- result.dg20 = jsonObject["DG20"];
- result.dg21 = jsonObject["DG21"];
-
- return result;
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "DG1": dg1,
- "DG2": dg2,
- "DG3": dg3,
- "DG4": dg4,
- "DG5": dg5,
- "DG6": dg6,
- "DG7": dg7,
- "DG8": dg8,
- "DG9": dg9,
- "DG10": dg10,
- "DG11": dg11,
- "DG12": dg12,
- "DG13": dg13,
- "DG14": dg14,
- "DG15": dg15,
- "DG16": dg16,
- "DG17": dg17,
- "DG18": dg18,
- "DG19": dg19,
- "DG20": dg20,
- "DG21": dg21,
- }.clearNulls();
-Allows you to deserialize object.
-static EPassportDataGroups fromJson(jsonObject) {
- var result = EPassportDataGroups();
- result.testSetters = {};
-
- result.dg1 = jsonObject["DG1"];
- result.dg2 = jsonObject["DG2"];
- result.dg3 = jsonObject["DG3"];
- result.dg4 = jsonObject["DG4"];
- result.dg5 = jsonObject["DG5"];
- result.dg6 = jsonObject["DG6"];
- result.dg7 = jsonObject["DG7"];
- result.dg8 = jsonObject["DG8"];
- result.dg9 = jsonObject["DG9"];
- result.dg10 = jsonObject["DG10"];
- result.dg11 = jsonObject["DG11"];
- result.dg12 = jsonObject["DG12"];
- result.dg13 = jsonObject["DG13"];
- result.dg14 = jsonObject["DG14"];
- result.dg15 = jsonObject["DG15"];
- result.dg16 = jsonObject["DG16"];
-
- return result;
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "DG1": dg1,
- "DG2": dg2,
- "DG3": dg3,
- "DG4": dg4,
- "DG5": dg5,
- "DG6": dg6,
- "DG7": dg7,
- "DG8": dg8,
- "DG9": dg9,
- "DG10": dg10,
- "DG11": dg11,
- "DG12": dg12,
- "DG13": dg13,
- "DG14": dg14,
- "DG15": dg15,
- "DG16": dg16,
- }.clearNulls();
-Enum contains all possible error codes
-Will be returned if getByValue if a non-existent was passed.
- - -ErrorCodes(-1)
- A Core framework is absent.
- - -ErrorCodes(0)
- The reader is not initialized or an unknown initialization error occured.
- - -ErrorCodes(1)
- This scenario is not supported based on your license and Core framework -capabilities.
- - -ErrorCodes(2)
- There are no results after recognition of camera frames.
- - -ErrorCodes(3)
- An error is encountered during database removal.
- - -ErrorCodes(4)
- An error is encountered during database download.
- - -ErrorCodes(5)
- An incorrect database ID.
- - -ErrorCodes(6)
- An incorrect database ID.
- - -ErrorCodes(7)
- An error is encountered during database save on your device.
- - -ErrorCodes(8)
- A database is corrupted.
- - -ErrorCodes(9)
- A database is corrupted.
- - -ErrorCodes(10)
- Deprecated.
- - -ErrorCodes(11)
- An RFID error.
- - -ErrorCodes(12)
- A license is absent or corrupted.
- - -ErrorCodes(13)
- An invalid date, i.e. the license may be expired, or the date and time of -set on the device doesn't correspond to reality.
- - -ErrorCodes(14)
- An invalid version.
- - -ErrorCodes(15)
- An invalid device ID.
- - -ErrorCodes(16)
- An invalid OS or application ID.
- - -ErrorCodes(17)
- There are no capabilities for this functionality in your license.
- - -ErrorCodes(18)
- There are no authenticity capabilities in your license.
- - -ErrorCodes(19)
- An invalid URL of the video during its generating.
- - -ErrorCodes(20)
- Something went wrong with online license processing.
- - -ErrorCodes(21)
- db.dat is absent.
- - -ErrorCodes(22)
- db.dat is incorrect.
- - -ErrorCodes(23)
- Failed to set TCC params.
- - -ErrorCodes(24)
- The operation failed due to RFID reading has already started.
- - -ErrorCodes(25)
- ErrorCodes(26)
- ErrorCodes(27)
- ErrorCodes(28)
- ErrorCodes(29)
- ErrorCodes(30)
- ErrorCodes(303)
- ErrorCodes(400)
- ErrorCodes(500)
- ErrorCodes(600)
- ErrorCodes(601)
- ErrorCodes(700)
- ErrorCodes(800)
- ErrorCodes(1000)
- [UNKNOWN, INITIALIZATION_CORE_ABSENT, INITIALIZATION_FAILED, INCORRECT_SCENARIO, NO_RESULT, REMOVE_DATABASE, FETCHING_DATABASE, DB_ID_NOT_FOUND, DB_DESCRIPTION_NOT_FOUND, SAVE_DB, DOWNLOAD_DB_INCORREC…
- const ErrorCodes
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-String? get data => _data;
-Allows you to deserialize object.
-static Extension? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Extension();
-
- result._data = jsonObject["data"];
- result._type = jsonObject["type"];
-
- return result;
-}
-String? get type => _type;
-FaceApiParams
-Allows you to deserialize object.
-static FaceApiParams? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return FaceApiParams(
- url: jsonObject["url"],
- mode: jsonObject["mode"],
- searchParams: FaceApiSearchParams.fromJson(jsonObject["searchParams"]),
- threshold: jsonObject["threshold"],
- serviceTimeout: jsonObject["serviceTimeout"],
- proxy: jsonObject["proxy"],
- proxyPassword: jsonObject["proxyPassword"],
- proxyType: jsonObject["proxyType"]);
-}
-The processing mode: "match" or "match+search".
-String get mode => _mode;
-Proxy to use, should be set according to the cURL standart.
-String? get proxy => _proxy;
-Username and password to use for proxy authentication, -should be set according to the cURL standart.
-String? get proxyPassword => _proxyPassword;
-Proxy protocol type, should be set according to the cURL standart.
-int? get proxyType => _proxyType;
-A search filter that can be applied if the "match+search" mode is enabled.
-FaceApiSearchParams? get searchParams => _searchParams;
-The service request timeout, ms.
-int get serviceTimeout => _serviceTimeout;
-The similarity threshold, 0-100. Above 75 means that the faces' similarity -is verified, below 75 is not.
-int get threshold => _threshold;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "url": url,
- "mode": mode,
- "threshold": threshold,
- "serviceTimeout": serviceTimeout,
- "proxy": proxy,
- "proxyPassword": proxyPassword,
- "proxyType": proxyType,
- "searchParams": searchParams?.toJson(),
- }.clearNulls();
-The URL of the Regula Face SDK service instance to be used.
-String get url => _url;
-Allows you to deserialize object.
-static FaceApiSearchParams? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return FaceApiSearchParams(
- limit: jsonObject["limit"],
- threshold: _toDouble(jsonObject["threshold"])!,
- groupIds: jsonObject["groupIds"] == null
- ? null
- : List<int>.from(jsonObject["groupIds"]),
- );
-}
-The number of returned Persons limit.
-int get limit => _limit;
-The similarity distance threshold, should be between 0.0 and 2.0, -where 0.0 is for returning results for only the most similar persons -and 2.0 is for all the persons, even the dissimilar ones. -If not set, the default 1.0 value is used.
-double get threshold => _threshold;
-Enum contains identifiers that determine the logical type of text data -obtained while reading MRZ, document filling fields, and barcodes.
-Will be returned if getByValue if a non-existent was passed.
- - -FieldType(-1)
- Document class code.
- - -FieldType(0)
- Issuing state code in compliance with 3166-1 standard (ICAO doc 9303).
- - -FieldType(1)
- Document number.
- - -FieldType(2)
- Expiry date of the document.
- - -FieldType(3)
- Issue date of the document.
- - -FieldType(4)
- Date of birth.
- - -FieldType(5)
- Place of birth.
- - -FieldType(6)
- Personal number.
- - -FieldType(7)
- Surname.
- - -FieldType(8)
- Given name(s).
- - -FieldType(9)
- Mother's name.
- - -FieldType(10)
- Nationality.
- - -FieldType(11)
- Sex.
- - -FieldType(12)
- Height.
- - -FieldType(13)
- Weight.
- - -FieldType(14)
- Eye color.
- - -FieldType(15)
- Hair color.
- - -FieldType(16)
- Address.
- - -FieldType(17)
- Organ donor indicator.
- - -FieldType(18)
- Social security number.
- - -FieldType(19)
- Driving licence classification code.
- - -FieldType(20)
- Driving licenсe endorsement code.
- - -FieldType(21)
- Driving licence restriction code.
- - -FieldType(22)
- Date of 21st birthday.
- - -FieldType(23)
- Issuing authority.
- - -FieldType(24)
- Surname and given name(s).
- - -FieldType(25)
- Nationality code in compliance with ISO3166-1 standard (ICAO doc 9303).
- - -FieldType(26)
- Passport number.
- - -FieldType(27)
- Invitation number.
- - -FieldType(28)
- Visa identification number.
- - -FieldType(29)
- Visa class.
- - -FieldType(30)
- Visa subclass.
- - -FieldType(31)
- Not used.
- - -FieldType(32)
- Not used.
- - -FieldType(33)
- Not used.
- - -FieldType(34)
- MRZ type (ID-1 – 0, ID-2 – 1, ID-3 – 2).
- - -FieldType(35)
- Optional data.
- - -FieldType(36)
- Document class name.
- - -FieldType(37)
- Issuing state name.
- - -FieldType(38)
- Place of issue.
- - -FieldType(39)
- Checksum for document number.
- - -FieldType(40)
- Checksum for date of birth.
- - -FieldType(41)
- Checksum for date of expiry.
- - -FieldType(42)
- Checksum for personal number.
- - -FieldType(43)
- Final checksum (for the whole MRZ).
- - -FieldType(44)
- Checksum for passport number (for visas).
- - -FieldType(45)
- Checksum for passport number (for visas).
- - -FieldType(46)
- Checksum for visa identification number.
- - -FieldType(47)
- Checksum for surname + given name(s).
- - -FieldType(48)
- Checksum for visa expiry date.
- - -FieldType(49)
- Other information.
- - -FieldType(50)
- MRZ lines.
- - -FieldType(51)
- Name suffix.
- - -FieldType(52)
- Name prefix.
- - -FieldType(53)
- Checksum for date of issue.
- - -FieldType(54)
- Check digit for date of issue.
- - -FieldType(55)
- Document series.
- - -FieldType(56)
- Serial number of registration certificate.
- - -FieldType(57)
- Vehicle model.
- - -FieldType(58)
- Vehicle color.
- - -FieldType(59)
- Vehicle identification number (VIN).
- - -FieldType(60)
- Vehicle type.
- - -FieldType(61)
- Permissible maximum weight.
- - -FieldType(62)
- Vehicle weight.
- - -FieldType(63)
- Address (area).
- - -FieldType(64)
- Address (state).
- - -FieldType(65)
- Address (building number).
- - -FieldType(66)
- Address (house number).
- - -FieldType(67)
- Address (flat number).
- - -FieldType(68)
- Place of registration.
- - -FieldType(69)
- Date of registration.
- - -FieldType(70)
- Resident from (date).
- - -FieldType(71)
- Resident until (date).
- - -FieldType(72)
- Issuing authority code (for the passport of the Russian Federation).
- - -FieldType(73)
- Place of birth (area).
- - -FieldType(74)
- Place of birth (state code).
- - -FieldType(75)
- Address (street).
- - -FieldType(76)
- Address (city).
- - -FieldType(77)
- Address (jurisdiction code).
- - -FieldType(78)
- Address (postal code).
- - -FieldType(79)
- Check digit for document number.
- - -FieldType(80)
- Check digit for date of birth.
- - -FieldType(81)
- Check digit for document expiry date.
- - -FieldType(82)
- Check digit for personal number.
- - -FieldType(83)
- Final check digit (for the whole MRZ).
- - -FieldType(84)
- Check digit for passport number (for visas).
- - -FieldType(85)
- Check digit for invitation number (for visas).
- - -FieldType(86)
- Check digit for visa number.
- - -FieldType(87)
- Check digit for surname and given name(s).
- - -FieldType(88)
- Check digit for visa expiry date.
- - -FieldType(89)
- Permit type.
- - -FieldType(90)
- Permit expiry date.
- - -FieldType(91)
- Permit identifier.
- - -FieldType(92)
- Permit issue date.
- - -FieldType(93)
- Driving permit restriction code.
- - -FieldType(94)
- Driving permit endorsement code.
- - -FieldType(95)
- A line used for document validation in accordance with the database.
- - -FieldType(96)
- Number of duplicates.
- - -FieldType(97)
- Medical indicator/code.
- - -FieldType(98)
- Indicator showing that the document holder is a non-resident.
- - -FieldType(99)
- Visa type.
- - -FieldType(100)
- The earliest date from which the visa is valid.
- - -FieldType(101)
- The date until which the visa is valid.
- - -FieldType(102)
- Duration of stay (in days) granted by the visa.
- - -FieldType(103)
- Number of entries granted by the visa.
- - -FieldType(104)
- Day in the date.
- - -FieldType(105)
- Month in the date.
- - -FieldType(106)
- Year in the date.
- - -FieldType(107)
- Identification number.
- - -FieldType(108)
- Commercial vehicle code.
- - -FieldType(109)
- Also known as (date of birth).
- - -FieldType(110)
- Also known as (social security number).
- - -FieldType(111)
- Also known as (surname).
- - -FieldType(112)
- Also known as (given names).
- - -FieldType(113)
- Also known as (suffix name).
- - -FieldType(114)
- Also known as (prefix name).
- - -FieldType(115)
- Mailing address (street).
- - -FieldType(116)
- Mailing address (city).
- - -FieldType(117)
- Mailing address (jurisdiction code).
- - -FieldType(118)
- Mailing address (postal code).
- - -FieldType(119)
- A number which is used for driving licence validation.
- - -FieldType(120)
- Race/ethnicity.
- - -FieldType(121)
- Race/ethnicity.
- - -FieldType(122)
- Jurisdiction vehicle class.
- - -FieldType(123)
- Jurisdiction endorsement code.
- - -FieldType(124)
- Jurisdiction restriction code.
- - -FieldType(125)
- Surname and (or) given name(s) at birth.
- - -FieldType(126)
- Given name(s) (Russian transcription).
- - -FieldType(127)
- Visa ID (Russian transcription).
- - -FieldType(128)
- Father’s name/patronymic.
- - -FieldType(129)
- Father’s name/patronymic (Russian transcription).
- - -FieldType(130)
- Surname and given name(s) (Russian transcription).
- - -FieldType(131)
- Place of birth (Russian transcription).
- - -FieldType(132)
- Document issuing authority (Russian transcription).
- - -FieldType(133)
- Numeric issuing state code in compliance with ISO 3166-1 standard.
- - -FieldType(134)
- Numeric nationality code in compliance with ISO 3166-1 standard.
- - -FieldType(135)
- Engine power.
- - -FieldType(136)
- Engine capacity.
- - -FieldType(137)
- Chassis number.
- - -FieldType(138)
- Engine number.
- - -FieldType(139)
- Engine model.
- - -FieldType(140)
- Vehicle category.
- - -FieldType(141)
- Identity card number.
- - -FieldType(142)
- Control number.
- - -FieldType(143)
- Parents' given names.
- - -FieldType(144)
- Second surname.
- - -FieldType(145)
- Second name.
- - -FieldType(146)
- Vehicle identification number.
- - -FieldType(147)
- Check digit for vehicle identification number.
- - -FieldType(148)
- Checksum for vehicle identification number.
- - -FieldType(149)
- Check digit for the first MRZ line.
- - -FieldType(150)
- Check digit for the second MRZ line.
- - -FieldType(151)
- Check digit for the third MRZ line.
- - -FieldType(152)
- Checksum for the first MRZ line.
- - -FieldType(153)
- Checksum for the second MRZ line.
- - -FieldType(154)
- Checksum for the third MRZ line.
- - -FieldType(155)
- Check digit for vehicle registration number.
- - -FieldType(156)
- Check sum for vehicle registration number.
- - -FieldType(157)
- Vehicle code according to ITS (IntelligentTransportation Systems).
- - -FieldType(158)
- Access number for RFID chip.
- - -FieldType(159)
- Marital status.
- - -FieldType(160)
- Company name.
- - -FieldType(161)
- Special notes.
- - -FieldType(162)
- Surname of spouse.
- - -FieldType(163)
- Number for checking document status.
- - -FieldType(164)
- Booklet number.
- - -FieldType(165)
- Children.
- - -FieldType(166)
- Copy number.
- - -FieldType(167)
- Serial number.
- - -FieldType(168)
- Dossier number.
- - -FieldType(169)
- Also known as (surname and given names).
- - -FieldType(170)
- Territorial validity.
- - -FieldType(171)
- MRZ with correct checksums.
- - -FieldType(172)
- Commercial driving license restriction code.
- - -FieldType(173)
- Date of 18th birthday.
- - -FieldType(174)
- Date of record creation.
- - -FieldType(175)
- Date of duplicate creation.
- - -FieldType(176)
- Type of issued driving license.
- - -FieldType(177)
- Military card number.
- - -FieldType(178)
- Destination.
- - -FieldType(179)
- Blood group.
- - -FieldType(180)
- Sequence number.
- - -FieldType(181)
- Car body type.
- - -FieldType(182)
- Car make.
- - -FieldType(183)
- Transaction number.
- - -FieldType(184)
- Age.
- - -FieldType(185)
- Folio number.
- - -FieldType(186)
- Voter's identification number.
- - -FieldType(187)
- Address (municipality).
- - -FieldType(188)
- Address (location).
- - -FieldType(189)
- Section/sector.
- - -FieldType(190)
- OCR number.
- - -FieldType(191)
- Federal elections.
- - -FieldType(192)
- Unique number.
- - -FieldType(193)
- Checksum for optional data.
- - -FieldType(194)
- Check digit for optional data.
- - -FieldType(195)
- Visa number.
- - -FieldType(196)
- Checksum for visa.
- - -FieldType(197)
- Checkdigit for visa.
- - -FieldType(198)
- Voter.
- - -FieldType(199)
- Type/number of the previous document.
- - -FieldType(200)
- Reserved for internal use.
- - -FieldType(220)
- Reserved for internal use.
- - -FieldType(221)
- Status expiry date.
- - -FieldType(251)
- Banknote number.
- - -FieldType(252)
- Customer Service Centre code.
- - -FieldType(253)
- Pseudonym.
- - -FieldType(254)
- Academic title.
- - -FieldType(255)
- Address (country).
- - -FieldType(256)
- Address (zip code).
- - -FieldType(257)
- Data on permanent residence permit 1(eID field).
- - -FieldType(258)
- Data on permanent residence permit 2(eID field).
- - -FieldType(259)
- Place of birth: street (eID field).
- - -FieldType(260)
- Place of birth: city (eID field).
- - -FieldType(261)
- Place of birth: state (eID field).
- - -FieldType(262)
- Place of birth: country (eID field).
- - -FieldType(263)
- Place of birth: zip code (eID field).
- - -FieldType(264)
- Commercial driving license class.
- - -FieldType(265)
- Date of 19th birthday.
- - -FieldType(266)
- Weight (pounds).
- - -FieldType(267)
- Indicator of document limited duration.
- - -FieldType(268)
- Endorsement expiry date.
- - -FieldType(269)
- Date of revision.
- - -FieldType(270)
- Type of compliance.
- - -FieldType(271)
- Family name truncation.
- - -FieldType(272)
- First name truncation.
- - -FieldType(273)
- Middle name truncation.
- - -FieldType(274)
- Examination date.
- - -FieldType(275)
- Organization.
- - -FieldType(276)
- Department.
- - -FieldType(277)
- Pay grade.
- - -FieldType(278)
- Rank/status/title.
- - -FieldType(279)
- Number that relates to benefit eligibility.
- - -FieldType(280)
- Sponsor's service.
- - -FieldType(281)
- Sponsor's status.
- - -FieldType(282)
- Sponsor.
- - -FieldType(283)
- Relationship.
- - -FieldType(284)
- Alien registration number issued by the U.S. -Citizenship and Immigration Service.
- - -FieldType(285)
- Category.
- - -FieldType(286)
- Conditions.
- - -FieldType(287)
- Identifier.
- - -FieldType(288)
- Configuration.
- - -FieldType(289)
- Discretionary data.
- - -FieldType(290)
- Optional data from MRZ Line 1.
- - -FieldType(291)
- Optional data from MRZ Line 2.
- - -FieldType(292)
- Optional data from MRZ Line 3.
- - -FieldType(293)
- Equivalence value (security code).
- - -FieldType(294)
- ALT сode.
- - -FieldType(295)
- Binary сode.
- - -FieldType(296)
- Pseudo-code.
- - -FieldType(297)
- Fee.
- - -FieldType(298)
- Stamp number.
- - -FieldType(299)
- Parameters of biometric data protection.
- - -FieldType(300)
- Parameters of biometric data integrity.
- - -FieldType(301)
- Date of creation of biometric data record.
- - -FieldType(302)
- Term of validity of biometric data record.
- - -FieldType(303)
- Version of header of biometric data format owner.
- - -FieldType(304)
- Type of biometric data record.
- - -FieldType(305)
- Type of biometric data.
- - -FieldType(306)
- Subtype of biometric data.
- - -FieldType(307)
- Identifier of biometric data.
- - -FieldType(308)
- Identifier of biometric data format owner.
- - -FieldType(309)
- Biometric data format.
- - -FieldType(310)
- DO's phone number.
- - -FieldType(311)
- DO's profession.
- - -FieldType(312)
- DO's title.
- - -FieldType(313)
- DO's personal summary data.
- - -FieldType(314)
- Other valid identifier.
- - -FieldType(315)
- Custody information.
- - -FieldType(316)
- Other name.
- - -FieldType(317)
- Observations.
- - -FieldType(318)
- Tax information.
- - -FieldType(319)
- Date of document personalization.
- - -FieldType(320)
- Serial number of personalization.
- - -FieldType(321)
- Other person's name.
- - -FieldType(322)
- Date of record entry on persons to notify in case of emergency.
- - -FieldType(323)
- Name of person to notify in case of emergency.
- - -FieldType(324)
- Phone number of person to notify in case of emergency.
- - -FieldType(325)
- Address of person to notify in case of emergency.
- - -FieldType(326)
- Textual information about the DS-certificate issuer.
- - -FieldType(327)
- Textual information about the document issuer.
- - -FieldType(328)
- Start date of the DS-certificate validity.
- - -FieldType(329)
- Expiration date of the DS-certificate.
- - -FieldType(330)
- Vehicle category/restrictions/conditions from -DG1 data group of eDL application.
- - -FieldType(331)
- Type approval number.
- - -FieldType(332)
- Administrative number.
- - -FieldType(333)
- Document discriminator.
- - -FieldType(334)
- Data discriminator.
- - -FieldType(335)
- ISO issuer ID number.
- - -FieldType(336)
- Registration number issued by GardaNational Immigration Bureau.
- - -FieldType(340)
- Department number.
- - -FieldType(341)
- Telegraph code.
- - -FieldType(342)
- Allergies.
- - -FieldType(343)
- Sp. code.
- - -FieldType(344)
- Code of restriction imposed by court.
- - -FieldType(345)
- County code.
- - -FieldType(346)
- Sponsor's social security number.
- - -FieldType(347)
- Department of Defense identification number.
- - -FieldType(348)
- Expiry date of Motorcycle status.
- - -FieldType(349)
- DUF Number (a number that is assigned to everyone who applies -for residence inNorway).
- - -FieldType(350)
- Code of Philippine Land TransportationOffice Agency.
- - -FieldType(351)
- Passenger name record (reservation code).
- - -FieldType(352)
- Code of the airport of departure.
- - -FieldType(353)
- Code of the airport of arrival.
- - -FieldType(354)
- Flight number.
- - -FieldType(355)
- Date of flight.
- - -FieldType(356)
- Seat number.
- - -FieldType(357)
- Date of boarding pass issue.
- - -FieldType(358)
- Expiration date of Concealed CarryWeapon Permit.
- - -FieldType(359)
- Checksum for reference number.
- - -FieldType(360)
- Check digit for reference number.
- - -FieldType(361)
- Room number.
- - -FieldType(362)
- Religion.
- - -FieldType(363)
- Months to expire.
- - -FieldType(364)
- Electronic ticket indicator.
- - -FieldType(365)
- Compartment сode.
- - -FieldType(366)
- Check-in sequence number on a boarding pass.
- - -FieldType(367)
- Code of the airline which issued the boarding pass.
- - -FieldType(368)
- Numeric airline code.
- - -FieldType(369)
- Ticket number.
- - -FieldType(370)
- Frequent flyer indicator.
- - -FieldType(371)
- Frequent flyer number.
- - -FieldType(372)
- Free baggage allowance.
- - -FieldType(373)
- Codec for PDF417.
- - -FieldType(374)
- Checksum for identity card number.
- - -FieldType(375)
- Check digit for identity card number.
- - -FieldType(376)
- Veteran.
- - -FieldType(377)
- DL class code A1 valid from.
- - -FieldType(378)
- DL class code A1 valid to.
- - -FieldType(379)
- DL class code A1 valid notes.
- - -FieldType(380)
- DL class code A1 valid from.
- - -FieldType(381)
- DL class code A1 valid to.
- - -FieldType(382)
- DL class code A1 valid notes.
- - -FieldType(383)
- DL class code B valid from.
- - -FieldType(384)
- DL class code B valid to.
- - -FieldType(385)
- DL class code B valid notes.
- - -FieldType(386)
- DL class code C1 valid from.
- - -FieldType(387)
- DL class code C1 valid to.
- - -FieldType(388)
- DL class code C1 valid notes.
- - -FieldType(389)
- DL class code C valid from.
- - -FieldType(390)
- DL class code C valid to.
- - -FieldType(391)
- DL class code C valid notes.
- - -FieldType(392)
- DL class code D1 valid from.
- - -FieldType(393)
- DL class code D1 valid to.
- - -FieldType(394)
- DL class code D1 valid notes.
- - -FieldType(395)
- DL class code D valid from.
- - -FieldType(396)
- DL class code D valid to.
- - -FieldType(397)
- DL class code D valid notes.
- - -FieldType(398)
- DL class code BE valid from.
- - -FieldType(399)
- DL class code BE valid to.
- - -FieldType(400)
- DL class code BE valid notes.
- - -FieldType(401)
- DL class code C1E valid from.
- - -FieldType(402)
- DL class code C1E valid to.
- - -FieldType(403)
- DL class code C1E valid notes.
- - -FieldType(404)
- DL class code CE valid from.
- - -FieldType(405)
- DL class code CE valid to.
- - -FieldType(406)
- DL class code CE valid notes.
- - -FieldType(407)
- DL class code D1E valid from.
- - -FieldType(408)
- DL class code D1E valid to.
- - -FieldType(409)
- DL class code D1E valid notes.
- - -FieldType(410)
- DL class code DE valid from.
- - -FieldType(411)
- DL class code DE valid to.
- - -FieldType(412)
- DL class code DE valid notes.
- - -FieldType(413)
- DL class code M valid from.
- - -FieldType(414)
- DL class code M valid to.
- - -FieldType(415)
- DL class code M valid notes.
- - -FieldType(416)
- DL class code L valid from.
- - -FieldType(417)
- DL class code L valid to.
- - -FieldType(418)
- DL class code L valid notes.
- - -FieldType(419)
- DL class code T valid from.
- - -FieldType(420)
- DL class code T valid to.
- - -FieldType(421)
- DL class code T valid notes.
- - -FieldType(422)
- DL class code AM valid from.
- - -FieldType(423)
- DL class code AM valid to.
- - -FieldType(424)
- DL class code AM valid notes.
- - -FieldType(425)
- DL class code A2 valid from.
- - -FieldType(426)
- DL class code A2 valid to.
- - -FieldType(427)
- DL class code A2 valid notes.
- - -FieldType(428)
- DL class code B1 valid from.
- - -FieldType(429)
- DL class code B1 valid to.
- - -FieldType(430)
- DL class code B1 valid notes.
- - -FieldType(431)
- Surname at birth.
- - -FieldType(432)
- Civil status.
- - -FieldType(433)
- Number of seats.
- - -FieldType(434)
- Number of standing places.
- - -FieldType(435)
- Maximum speed.
- - -FieldType(436)
- Fuel type.
- - -FieldType(437)
- Vehicle environmental type.
- - -FieldType(438)
- Power–to–weight ratio.
- - -FieldType(439)
- Maximum weight of the trailer without brakes.
- - -FieldType(440)
- Maximum weight of the trailer without brakes.
- - -FieldType(441)
- Transmission type.
- - -FieldType(442)
- Trailer hitch.
- - -FieldType(443)
- Accompanying person.
- - -FieldType(444)
- Police district.
- - -FieldType(445)
- Date of first issue.
- - -FieldType(446)
- Payload capacity.
- - -FieldType(447)
- Number of axels.
- - -FieldType(448)
- Permissible axle load.
- - -FieldType(449)
- Precinct.
- - -FieldType(450)
- Invited by.
- - -FieldType(451)
- Purpose of entry.
- - -FieldType(452)
- Skin color.
- - -FieldType(453)
- Complexion.
- - -FieldType(454)
- Airport of departure.
- - -FieldType(455)
- Airport of arrival.
- - -FieldType(456)
- Airline name.
- - -FieldType(457)
- A loyalty program offered by the airline to its customers who fly frequently.
- - -FieldType(458)
- Licenсe number.
- - -FieldType(459)
- In tanks.
- - -FieldType(460)
- Except in tanks.
- - -FieldType(461)
- Passenger using the Fast Track service in the airport.
- - -FieldType(462)
- Owner.
- - -FieldType(463)
- MRZ strings from ICAO RFID.
- - -FieldType(464)
- The number of times a card with this number has been issued.
- - -FieldType(465)
- Number of card issuance checksum.
- - -FieldType(466)
- Number of card issuance check digit.
- - -FieldType(467)
- Century of birth.
- - -FieldType(468)
- DL class code A3 valid from.
- - -FieldType(469)
- DL class code A3 valid to.
- - -FieldType(470)
- DL class code A3 valid notes.
- - -FieldType(471)
- DL class code C2 valid from.
- - -FieldType(472)
- DL class code C2 valid to.
- - -FieldType(473)
- DL class code C2 valid notes.
- - -FieldType(474)
- DL class code B2 valid from.
- - -FieldType(475)
- DL class code B2 valid to.
- - -FieldType(476)
- DL class code B2 valid notes.
- - -FieldType(477)
- DL class code D2 valid from.
- - -FieldType(478)
- DL class code B2 valid to.
- - -FieldType(479)
- DL class code B2 valid notes.
- - -FieldType(480)
- DL class code B2E valid from.
- - -FieldType(481)
- DL class code B2E valid to.
- - -FieldType(482)
- DL class code B2E valid notes.
- - -FieldType(483)
- DL class code G valid from.
- - -FieldType(484)
- DL class code G valid to.
- - -FieldType(485)
- DL class code G valid notes.
- - -FieldType(486)
- DL class code J valid from.
- - -FieldType(487)
- DL class code J valid to.
- - -FieldType(488)
- DL class code J valid notes.
- - -FieldType(489)
- DL class code LC valid from.
- - -FieldType(490)
- DL class code LC valid to.
- - -FieldType(491)
- DL class code LC valid notes.
- - -FieldType(492)
- Bank card number.
- - -FieldType(493)
- Bank card validity.
- - -FieldType(494)
- Tax number.
- - -FieldType(495)
- Health insurance number.
- - -FieldType(496)
- Grandfather's name.
- - -FieldType(497)
- Selectee indicator.
- - -FieldType(498)
- Mother's surname.
- - -FieldType(499)
- Mother's given name.
- - -FieldType(500)
- Father's surname.
- - -FieldType(501)
- Father's given name.
- - -FieldType(502)
- Mother's date of birth.
- - -FieldType(503)
- Father's date of birth.
- - -FieldType(504)
- Mother's personal number.
- - -FieldType(505)
- Father's personal number.
- - -FieldType(506)
- Mother's place of birth.
- - -FieldType(507)
- Father's place of birth.
- - -FieldType(508)
- Mother's country of birth.
- - -FieldType(509)
- Father's country of birth.
- - -FieldType(510)
- Date of first renewal.
- - -FieldType(511)
- Date of second renewal.
- - -FieldType(512)
- Place of examination.
- - -FieldType(513)
- Application number.
- - -FieldType(514)
- Voucher number.
- - -FieldType(515)
- Authorization number.
- - -FieldType(516)
- Faculty.
- - -FieldType(517)
- Form of education.
- - -FieldType(518)
- DNI number.
- - -FieldType(519)
- Retirement number.
- - -FieldType(520)
- Professional Id number.
- - -FieldType(521)
- Age at issue.
- - -FieldType(522)
- Years since issue.
- - -FieldType(523)
- DL class code BTP valid from.
- - -FieldType(524)
- DL class code BTP valid notes.
- - -FieldType(525)
- DL class code BTP valid to.
- - -FieldType(526)
- DL class code C3 valid from.
- - -FieldType(527)
- DL class code C3 valid notes.
- - -FieldType(528)
- DL class code C3 valid to.
- - -FieldType(529)
- DL class code E valid from.
- - -FieldType(530)
- DL class code E valid notes.
- - -FieldType(531)
- DL class code E valid to.
- - -FieldType(532)
- DL class code F valid from.
- - -FieldType(533)
- DL class code F valid notes.
- - -FieldType(534)
- DL class code F valid to.
- - -FieldType(535)
- DL class code FA valid from.
- - -FieldType(536)
- DL class code FA valid notes.
- - -FieldType(537)
- DL class code FA valid to.
- - -FieldType(538)
- DL class code FA1 valid from.
- - -FieldType(539)
- DL class code FA1 valid notes.
- - -FieldType(540)
- DL class code FA1 valid to.
- - -FieldType(541)
- DL class code FB valid from.
- - -FieldType(542)
- DL class code FB valid notes.
- - -FieldType(543)
- DL class code FB valid to.
- - -FieldType(544)
- DL class code G1 valid from.
- - -FieldType(545)
- DL class code G1 valid notes.
- - -FieldType(546)
- DL class code G1 valid to.
- - -FieldType(547)
- DL class code H valid from.
- - -FieldType(548)
- DL class code H valid notes.
- - -FieldType(549)
- DL class code H valid to.
- - -FieldType(550)
- DL class code I valid from.
- - -FieldType(551)
- DL class code I valid notes.
- - -FieldType(552)
- DL class code I valid to.
- - -FieldType(553)
- DL class code K valid from.
- - -FieldType(554)
- DL class code K valid notes.
- - -FieldType(555)
- DL class code K valid to.
- - -FieldType(556)
- DL class code LK valid from.
- - -FieldType(557)
- DL class code LK valid notes.
- - -FieldType(558)
- DL class code LK valid to.
- - -FieldType(559)
- DL class code N valid from.
- - -FieldType(560)
- DL class code N valid notes.
- - -FieldType(561)
- DL class code N valid to.
- - -FieldType(562)
- DL class code S valid from.
- - -FieldType(563)
- DL class code S valid notes.
- - -FieldType(564)
- DL class code S valid to.
- - -FieldType(565)
- DL class code TB valid from.
- - -FieldType(566)
- DL class code TB valid notes.
- - -FieldType(567)
- DL class code TB valid to.
- - -FieldType(568)
- DL class code TM valid from.
- - -FieldType(569)
- DL class code TM valid notes.
- - -FieldType(570)
- DL class code TM valid to.
- - -FieldType(571)
- DL class code TR valid from.
- - -FieldType(572)
- DL class code TR valid notes.
- - -FieldType(573)
- DL class code TR valid to.
- - -FieldType(574)
- DL class code TV valid from.
- - -FieldType(575)
- DL class code TV valid notes.
- - -FieldType(576)
- DL class code TV valid to.
- - -FieldType(577)
- DL class code V valid from.
- - -FieldType(578)
- DL class code V valid notes.
- - -FieldType(579)
- DL class code V valid to.
- - -FieldType(580)
- DL class code W valid from.
- - -FieldType(581)
- DL class code W valid notes.
- - -FieldType(582)
- DL class code W valid to.
- - -FieldType(583)
- Uniform Resource Locator.
- - -FieldType(584)
- Caliber.
- - -FieldType(585)
- Model.
- - -FieldType(586)
- Make.
- - -FieldType(587)
- Number of cylinders.
- - -FieldType(588)
- Surname of husband after registration.
- - -FieldType(589)
- Surname of wife after registration.
- - -FieldType(590)
- Wife's date of birth.
- - -FieldType(591)
- Husband's date of birth.
- - -FieldType(592)
- Citizenship of the first person.
- - -FieldType(593)
- Citizenship of the second person.
- - -FieldType(594)
- Card Security Code.
- - -FieldType(595)
- Date of insurance expiry.
- - -FieldType(596)
- Mortgage by.
- - -FieldType(597)
- Old document number.
- - -FieldType(598)
- Old date of issue.
- - -FieldType(599)
- Old place of issue.
- - -FieldType(600)
- DL category LR valid from.
- - -FieldType(601)
- DL category LR valid to.
- - -FieldType(602)
- DL category LR valid notes.
- - -FieldType(603)
- DL category MR valid from.
- - -FieldType(604)
- DL category MR valid to.
- - -FieldType(605)
- DL category MR valid notes.
- - -FieldType(606)
- DL category HR valid from.
- - -FieldType(607)
- DL category HR valid to.
- - -FieldType(608)
- DL category HR valid notes.
- - -FieldType(609)
- DL category HC valid from.
- - -FieldType(610)
- DL category HC valid to.
- - -FieldType(611)
- DL category HC valid notes.
- - -FieldType(612)
- DL category MC valid from.
- - -FieldType(613)
- DL category MC valid to.
- - -FieldType(614)
- DL category MC valid notes.
- - -FieldType(615)
- DL category RE valid from.
- - -FieldType(616)
- DL category RE valid to.
- - -FieldType(617)
- DL category RE valid notes.
- - -FieldType(618)
- DL category R valid from.
- - -FieldType(619)
- DL category R valid to.
- - -FieldType(620)
- DL category R valid notes.
- - -FieldType(621)
- DL category CA valid from.
- - -FieldType(622)
- DL category CA valid to.
- - -FieldType(623)
- DL category CA valid notes.
- - -FieldType(624)
- Citizenship status.
- - -FieldType(625)
- Start date of military service.
- - -FieldType(626)
- End date of military service.
- - -FieldType(627)
- DL category NT valid notes.
- - -FieldType(628)
- DL category NT valid to.
- - -FieldType(629)
- DL category NT valid notes.
- - -FieldType(630)
- DL category TN valid from.
- - -FieldType(631)
- DL category TN valid to.
- - -FieldType(632)
- DL category TN valid notes.
- - -FieldType(633)
- DL category D3 valid from.
- - -FieldType(634)
- DL category D3 valid to.
- - -FieldType(635)
- DL category D3 valid notes.
- - -FieldType(636)
- Alternative date of expiry.
- - -FieldType(637)
- DL category CD valid from.
- - -FieldType(638)
- DL category CD valid to.
- - -FieldType(639)
- DL category CD valid notes.
- - -FieldType(640)
- End date of payment period.
- - -FieldType(643)
- Start date of payment period.
- - -FieldType(642)
- Issuer identification number (IIN).
- - -FieldType(641)
- Vaccination certificate identifier.
- - -FieldType(644)
- First name.
- - -FieldType(645)
- Date of arrival.
- - -FieldType(646)
- Second name.
- - -FieldType(647)
- Third name.
- - -FieldType(648)
- Fourth name.
- - -FieldType(649)
- Last name.
- - -FieldType(650)
- DL class code RM valid from.
- - -FieldType(651)
- DL class code RM notes.
- - -FieldType(652)
- DL class code RM valid to.
- - -FieldType(653)
- DL class code PW valid from.
- - -FieldType(654)
- DL class code PW notes.
- - -FieldType(655)
- DL class code PW valid to.
- - -FieldType(656)
- FieldType(657)
- FieldType(658)
- FieldType(659)
- FieldType(660)
- FieldType(661)
- FieldType(662)
- FieldType(663)
- FieldType(664)
- FieldType(665)
- FieldType(666)
- FieldType(667)
- FieldType(668)
- FieldType(669)
- FieldType(670)
- FieldType(671)
- FieldType(672)
- FieldType(673)
- FieldType(674)
- FieldType(675)
- FieldType(676)
- FieldType(677)
- FieldType(678)
- FieldType(679)
- FieldType(680)
- Date of retirement.
- - -FieldType(681)
- Document status.
- - -FieldType(682)
- Signature.
- - -FieldType(683)
- [UNKNOWN, DOCUMENT_CLASS_CODE, ISSUING_STATE_CODE, DOCUMENT_NUMBER, DATE_OF_EXPIRY, DATE_OF_ISSUE, DATE_OF_BIRTH, PLACE_OF_BIRTH, PERSONAL_NUMBER, SURNAME, GIVEN_NAMES, MOTHERS_NAME, NATIONALITY, SEX,…
- const FieldType
-final int value;
-SecurityObjectCertificates? get certificates => _certificates;
-FileData? get fileData => _fileData;
-String? get fileID => _fileID;
-Allows you to deserialize object.
-static File? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = File();
-
- result._readingTime = jsonObject["readingTime"];
- result._type = RFIDDataFileType.getByValue(jsonObject["type"])!;
- result._typeName = jsonObject["typeName"];
- result._pAStatus = RFIDErrorCodes.getByValue(jsonObject["pAStatus"])!;
- result._readingStatus =
- RFIDErrorCodes.getByValue(jsonObject["readingStatus"])!;
- result._fileID = jsonObject["fileID"];
- result._fileData = FileData.fromJson(jsonObject["fileData"]);
- result._certificates =
- SecurityObjectCertificates.fromJson(jsonObject["certificates"]);
- result._docFieldsText = jsonObject["docFieldsText"].cast<int>();
- result._docFieldsGraphics = jsonObject["docFieldsGraphics"].cast<int>();
- result._docFieldsOriginals = jsonObject["docFieldsOriginals"].cast<int>();
- result._notifications = jsonObject["notifications"].cast<int>();
-
- return result;
-}
-RFIDErrorCodes get pAStatus => _pAStatus;
-RFIDErrorCodes get readingStatus => _readingStatus;
-int get readingTime => _readingTime;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "fileData": fileData?.toJson(),
- "fileID": fileID,
- "notifications": notifications,
- "pAStatus": pAStatus.value,
- "readingStatus": readingStatus.value,
- "readingTime": readingTime,
- "type": type.value,
- "typeName": typeName,
- "docFieldsText": docFieldsText,
- "docFieldsGraphics": docFieldsGraphics,
- "docFieldsOriginals": docFieldsOriginals,
- "certificates": certificates?.toJson(),
- }.clearNulls();
-RFIDDataFileType get type => _type;
-String get typeName => _typeName;
-String? get data => _data;
-Allows you to serialize object.
-static FileData? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = FileData();
-
- result._length = jsonObject["length"];
- result._type = jsonObject["type"];
- result._status = jsonObject["status"];
- result._data = jsonObject["data"];
-
- return result;
-}
-int get length => _length;
-int get status => _status;
-int get type => _type;
-Type for receiving answer after backend processing has finished.
-DocReaderAction defines processing status.
-TransactionInfo contains transactionId and tag.
-DocReaderException in case of anything is wrong - brief message for developer, null otherwise.
typedef FinalizePackageCompletion = (
- DocReaderAction action,
- TransactionInfo? info,
- DocReaderException? error,
-);
-Allows you to deserialize object.
-static Font? fromJson(jsonObject) {
- if (jsonObject == null) return null;
-
- var result = Font(jsonObject["name"]);
- result._size = jsonObject["size"];
- result._style = FontStyle.getByValue(jsonObject["style"]);
-
- return result;
-}
-Font family.
-Beware that Android and iOS have diffrent font names, -so you will have to use if condition.
-String get name => _name;
-Font size.
-int? get size => _size;
-Font style.
-Android only.
-FontStyle? get style => _style;
-Will be returned if getByValue if a non-existent was passed.
- - -FontStyle(-1)
- FontStyle(0)
- FontStyle(1)
- FontStyle(2)
- FontStyle(3)
- const FontStyle
-final int value;
-Will be returned if getByValue if a non-existent was passed.
- - -FrameShapeType(-1)
- Camera frame is rectangle.
- - -FrameShapeType(0)
- Camera frame only consists of corners of the rectangle.
- - -FrameShapeType(1)
- [UNKNOWN, LINE, CORNER]
- const FrameShapeType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Params that influence the scanning process, camera view controller -customization and etc.
-true, the metadata will be displayed over the camera
-preview during document processing, namely the perspective angle value.
- true, allows you to adjust a zoom level using the pinch
-gesture (its range is from 1x to 10x).
- true, scanner operate in manual multipage scanning mode.
-Set this flag to true, if you wanna create for example, custom logic
-(or UI) between scanning document pages.
- true, as soon as document is located during video mode,
-picture wil be taken and processed as single frame.
- true, video during processing of the document will be recorded.
-This can be used later for debugging and troubleshooting.
- true, the button that allows you to change a position
-of a capture device for the video session will be displayed.
- true, the button that allows you to take a picture
-and process it as a single frame will be displayed.
- true,
-otherwise, it won't be displayed.
- true,
-otherwise, it won't be displayed.
- true, the button that allows you to change the camera
-frame type will be displayed.
- true, the button that allows you to close the scanner
-will be displayed.
- true, the button that allows you to skip processing
-of the next page of a document will be displayed.
- true, the button that allows you to turn on/off
-the torch will be displayed.
- true, once the scanning process is finished,
-the scanner will be dismissed.
- true, camera frames won't be taken for recognition
-while a camera is focusing.
- true, allows you to connect to the external
-Regula Bluetooth devices like Regula 1120 and others.
- true, camera frames won't be taken for recognition
-while a device is moving based on motion sensors.
- Allows you to specify a name of a Regula device that will be used -with Document Reader SDK.
-String? get btDeviceName => _btDeviceName;
-set btDeviceName(String? val) {
- _btDeviceName = val;
- _set({"btDeviceName": val});
-}
-Set this setting to override the default cropping frame provided by scenarios.
-Default: DocReaderFrame.SCENARIO_DEFAULT.
-DocReaderFrame? get cameraFrame => _cameraFrame;
-set cameraFrame(DocReaderFrame? val) {
- _cameraFrame = val;
- _set({"cameraFrame": val?.value});
-}
-Allows you to specify the camera API.
-Default: CameraMode.AUTO.
-Android only.
-CameraMode? get cameraMode => _cameraMode;
-set cameraMode(CameraMode? val) {
- _cameraMode = val;
- _set({"cameraMode": val?.value});
-}
-Allows you to specify a position of a capture device for the video session.
-Default: CameraPosition.UNSPECIFIED.
-IOS only.
-CameraPosition? get cameraPositionIOS => _cameraPositionIOS;
-set cameraPositionIOS(CameraPosition? val) {
- _cameraPositionIOS = val;
- _set({"cameraPositionIOS": val?.value});
-}
-Allows you to specify the frame resolution.
-Android only. For iOS use cameraResolutionIOS
-CameraSize? get cameraResolutionAndroid => _cameraResolutionAndroid;
-set cameraResolutionAndroid(CameraSize? val) {
- _cameraResolutionAndroid = val;
- _set({"cameraSize": val?.toJson()});
-}
-Allows you to specify the frame resolution.
-iOS only. For Android use cameraResolutionAndroid
-CaptureSessionPreset? get cameraResolutionIOS => _cameraResolutionIOS;
-set cameraResolutionIOS(CaptureSessionPreset? val) {
- _cameraResolutionIOS = val;
- _set({"videoSessionPreset": val?.value});
-}
-Allows you to specify the video processing mode.
-Default: CaptureMode.AUTO.
-CaptureMode? get captureMode => _captureMode;
-set captureMode(CaptureMode? val) {
- _captureMode = val;
- _set({"captureMode": val?.value});
-}
-If it's set to true, the metadata will be displayed over the camera
-preview during document processing, namely the perspective angle value.
Default: false.
bool? get displayMetadata => _displayMetadata;
-set displayMetadata(bool? val) {
- _displayMetadata = val;
- _set({"displayMetadata": val});
-}
-A list of devices that must not use the camera2 API.
-Android only.
-List<String>? get excludedCamera2Models => _excludedCamera2Models;
-set excludedCamera2Models(List<String>? val) {
- _excludedCamera2Models = val;
- _set({"excludedCamera2Models": val});
-}
-Allows you to control exposure.
-Android only.
-double? get exposure => _exposure;
-set exposure(double? val) {
- _exposure = val;
- _set({"exposure": val});
-}
-Sets a limit on the number of pages to be processed.
-int? get forcePagesCount => _forcePagesCount;
-set forcePagesCount(int? val) {
- _forcePagesCount = val;
- _set({"forcePagesCount": val});
-}
-Allows you to deserialize object.
-static Functionality fromJson(jsonObject) {
- var result = Functionality();
- result.testSetters = {};
-
- result.pictureOnBoundsReady = jsonObject["pictureOnBoundsReady"];
- result.showTorchButton = jsonObject["showTorchButton"];
- result.showCloseButton = jsonObject["showCloseButton"];
- result.videoCaptureMotionControl = jsonObject["videoCaptureMotionControl"];
- result.showCaptureButton = jsonObject["showCaptureButton"];
- result.showChangeFrameButton = jsonObject["showChangeFrameButton"];
- result.showSkipNextPageButton = jsonObject["showSkipNextPageButton"];
- result.useAuthenticator = jsonObject["useAuthenticator"];
- result.skipFocusingFrames = jsonObject["skipFocusingFrames"];
- result.showCameraSwitchButton = jsonObject["showCameraSwitchButton"];
- result.displayMetadata = jsonObject["displayMetadata"];
- result.isZoomEnabled = jsonObject["isZoomEnabled"];
- result.isCameraTorchCheckDisabled =
- jsonObject["isCameraTorchCheckDisabled"];
- result.recordScanningProcess = jsonObject["recordScanningProcess"];
- result.manualMultipageMode = jsonObject["manualMultipageMode"];
- result.singleResult = jsonObject["singleResult"];
-
- result.showCaptureButtonDelayFromDetect =
- jsonObject["showCaptureButtonDelayFromDetect"];
- result.showCaptureButtonDelayFromStart =
- jsonObject["showCaptureButtonDelayFromStart"];
- result.rfidTimeout = jsonObject["rfidTimeout"];
- result.forcePagesCount = jsonObject["forcePagesCount"];
- result.orientation =
- DocReaderOrientation.getByValue(jsonObject["orientation"]);
- result.captureMode = CaptureMode.getByValue(jsonObject["captureMode"]);
- result.cameraMode = CameraMode.getByValue(jsonObject["cameraMode"]);
- result.cameraPositionIOS =
- CameraPosition.getByValue(jsonObject["cameraPositionIOS"]);
-
- result.cameraFrame = DocReaderFrame.getByValue(jsonObject["cameraFrame"]);
- result.btDeviceName = jsonObject["btDeviceName"];
-
- result.zoomFactor = _toDouble(jsonObject["zoomFactor"]);
- result.exposure = _toDouble(jsonObject["exposure"]);
-
- result.excludedCamera2Models = jsonObject["excludedCamera2Models"] == null
- ? null
- : List<String>.from(jsonObject["excludedCamera2Models"]);
-
- result.cameraResolutionAndroid =
- CameraSize.fromJson(jsonObject["cameraSize"]);
- result.cameraResolutionIOS =
- CaptureSessionPreset.getByValue(jsonObject["videoSessionPreset"]);
-
- return result;
-}
-Allows you to disable all validations of having a torch in case Android -returns that it's not available, but it can be used when checks are skipped.
-Default: false.
Android only.
-bool? get isCameraTorchCheckDisabled => _isCameraTorchCheckDisabled;
-set isCameraTorchCheckDisabled(bool? val) {
- _isCameraTorchCheckDisabled = val;
- _set({"isCameraTorchCheckDisabled": val});
-}
-If it's set to true, allows you to adjust a zoom level using the pinch
-gesture (its range is from 1x to 10x).
Default: false.
bool? get isZoomEnabled => _isZoomEnabled;
-set isZoomEnabled(bool? val) {
- _isZoomEnabled = val;
- _set({"isZoomEnabled": val});
-}
-If it's set to true, scanner operate in manual multipage scanning mode.
-Set this flag to true, if you wanna create for example, custom logic
-(or UI) between scanning document pages.
Default: false.
bool? get manualMultipageMode => _manualMultipageMode;
-set manualMultipageMode(bool? val) {
- _manualMultipageMode = val;
- _set({"manualMultipageMode": val});
-}
-Allows you to specify an orientation of the camera view controller.
-Default: DocReaderOrientation.ALL.
-DocReaderOrientation? get orientation => _orientation;
-set orientation(DocReaderOrientation? val) {
- _orientation = val;
- _set({"orientation": val?.value});
-}
-If set to true, as soon as document is located during video mode,
-picture wil be taken and processed as single frame.
Used for devices with poor-quality video preview.
-Android only.
-bool? get pictureOnBoundsReady => _pictureOnBoundsReady;
-set pictureOnBoundsReady(bool? val) {
- _pictureOnBoundsReady = val;
- _set({"pictureOnBoundsReady": val});
-}
-If set to true, video during processing of the document will be recorded.
-This can be used later for debugging and troubleshooting.
Default: false.
bool? get recordScanningProcess => _recordScanningProcess;
-set recordScanningProcess(bool? val) {
- _recordScanningProcess = val;
- _set({"recordScanningProcess": val});
-}
-Use the parameter to set the time limit (in seconds) for the RFID chip reading, -beyond which it does not continue regardless of its result.
-Android only.
-int? get rfidTimeout => _rfidTimeout;
-set rfidTimeout(int? val) {
- _rfidTimeout = val;
- _set({"rfidTimeout": val});
-}
-If it's set to true, the button that allows you to change a position
-of a capture device for the video session will be displayed.
Default: false.
bool? get showCameraSwitchButton => _showCameraSwitchButton;
-set showCameraSwitchButton(bool? val) {
- _showCameraSwitchButton = val;
- _set({"showCameraSwitchButton": val});
-}
-If it's set to true, the button that allows you to take a picture
-and process it as a single frame will be displayed.
Default: false.
bool? get showCaptureButton => _showCaptureButton;
-set showCaptureButton(bool? val) {
- _showCaptureButton = val;
- _set({"showCaptureButton": val});
-}
-Allows you to specify a time interval when the Capture button
-has to be displayed after the document is detected.
-Don't forget to set the showCaptureButton to true,
-otherwise, it won't be displayed.
Default: 5.
-int? get showCaptureButtonDelayFromDetect =>
- _showCaptureButtonDelayFromDetect;
-set showCaptureButtonDelayFromDetect(int? val) {
- _showCaptureButtonDelayFromDetect = val;
- _set({"showCaptureButtonDelayFromDetect": val});
-}
-Allows you to specify a time interval when the Capture button
-has to be displayed after the scanning process is started.
-Don't forget to set the showCaptureButton to true,
-otherwise, it won't be displayed.
Default: 10.
-int? get showCaptureButtonDelayFromStart => _showCaptureButtonDelayFromStart;
-set showCaptureButtonDelayFromStart(int? val) {
- _showCaptureButtonDelayFromStart = val;
- _set({"showCaptureButtonDelayFromStart": val});
-}
-If it's set to true, the button that allows you to change the camera
-frame type will be displayed.
Default: false.
bool? get showChangeFrameButton => _showChangeFrameButton;
-set showChangeFrameButton(bool? val) {
- _showChangeFrameButton = val;
- _set({"showChangeFrameButton": val});
-}
-If it's set to true, the button that allows you to close the scanner
-will be displayed.
Default: true.
bool? get showCloseButton => _showCloseButton;
-set showCloseButton(bool? val) {
- _showCloseButton = val;
- _set({"showCloseButton": val});
-}
-If it's set to true, the button that allows you to skip processing
-of the next page of a document will be displayed.
Default: true.
bool? get showSkipNextPageButton => _showSkipNextPageButton;
-set showSkipNextPageButton(bool? val) {
- _showSkipNextPageButton = val;
- _set({"showSkipNextPageButton": val});
-}
-If it's set to true, the button that allows you to turn on/off
-the torch will be displayed.
Default: true.
bool? get showTorchButton => _showTorchButton;
-set showTorchButton(bool? val) {
- _showTorchButton = val;
- _set({"showTorchButton": val});
-}
-If it's set to true, once the scanning process is finished,
-the scanner will be dismissed.
Default: true.
iOS only.
-bool? get singleResult => _singleResult;
-set singleResult(bool? val) {
- _singleResult = val;
- _set({"singleResult": val});
-}
-If it's set to true, camera frames won't be taken for recognition
-while a camera is focusing.
Default: true.
bool? get skipFocusingFrames => _skipFocusingFrames;
-set skipFocusingFrames(bool? val) {
- _skipFocusingFrames = val;
- _set({"skipFocusingFrames": val});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "pictureOnBoundsReady": pictureOnBoundsReady,
- "showTorchButton": showTorchButton,
- "showCloseButton": showCloseButton,
- "videoCaptureMotionControl": videoCaptureMotionControl,
- "showCaptureButton": showCaptureButton,
- "showChangeFrameButton": showChangeFrameButton,
- "showSkipNextPageButton": showSkipNextPageButton,
- "useAuthenticator": useAuthenticator,
- "skipFocusingFrames": skipFocusingFrames,
- "showCameraSwitchButton": showCameraSwitchButton,
- "displayMetadata": displayMetadata,
- "isZoomEnabled": isZoomEnabled,
- "isCameraTorchCheckDisabled": isCameraTorchCheckDisabled,
- "recordScanningProcess": recordScanningProcess,
- "manualMultipageMode": manualMultipageMode,
- "singleResult": singleResult,
- "showCaptureButtonDelayFromDetect": showCaptureButtonDelayFromDetect,
- "showCaptureButtonDelayFromStart": showCaptureButtonDelayFromStart,
- "rfidTimeout": rfidTimeout,
- "forcePagesCount": forcePagesCount,
- "orientation": orientation?.value,
- "captureMode": captureMode?.value,
- "cameraMode": cameraMode?.value,
- "cameraPositionIOS": cameraPositionIOS?.value,
- "cameraFrame": cameraFrame?.value,
- "btDeviceName": btDeviceName,
- "zoomFactor": zoomFactor,
- "exposure": exposure,
- "excludedCamera2Models": excludedCamera2Models,
- "cameraSize": cameraResolutionAndroid?.toJson(),
- "videoSessionPreset": cameraResolutionIOS?.value,
- }.clearNulls();
-If it's set to true, allows you to connect to the external
-Regula Bluetooth devices like Regula 1120 and others.
bool? get useAuthenticator => _useAuthenticator;
-set useAuthenticator(bool? val) {
- _useAuthenticator = val;
- _set({"useAuthenticator": val});
-}
-If it's set to true, camera frames won't be taken for recognition
-while a device is moving based on motion sensors.
Default: true.
bool? get videoCaptureMotionControl => _videoCaptureMotionControl;
-set videoCaptureMotionControl(bool? val) {
- _videoCaptureMotionControl = val;
- _set({"videoCaptureMotionControl": val});
-}
-Allows you to set the desired zoom level (its range from 1x to 10x).
-Default: 1.0.
-double? get zoomFactor => _zoomFactor;
-set zoomFactor(double? val) {
- _zoomFactor = val;
- _set({"zoomFactor": val});
-}
-Allows you to deserialize object.
-static GlaresCheckParams? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return GlaresCheckParams(
- imgMarginPart: _toDouble(jsonObject["imgMarginPart"]),
- maxGlaringPart: _toDouble(jsonObject["maxGlaringPart"]),
- );
-}
-Part of margin from the edges of the image that is ignored by glares check. -Example: value 0.07 is 7% of image area is ignored.
-double? get imgMarginPart => _imgMarginPart;
-The maximum allowable part of glared area. -Example: value 0.1 is 10% allowed.
-double? get maxGlaringPart => _maxGlaringPart;
-Structure, describing single graphic field extracted.
-Graphic field symbolic name.
-String get fieldName => _fieldName;
-Field area coordinates on the general image.
-Rect? get fieldRect => _fieldRect;
-Graphic field logical type.
-GraphicFieldType get fieldType => _fieldType;
-Allows you to deserialize object.
-static GraphicField? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = GraphicField();
-
- result._sourceType = ResultType.getByValue(jsonObject["sourceType"])!;
- result._fieldType = GraphicFieldType.getByValue(jsonObject["fieldType"])!;
- result._light = Lights.getByValue(jsonObject["light"])!;
- result._pageIndex = jsonObject["pageIndex"];
- result._originalPageIndex = jsonObject["originalPageIndex"];
- result._fieldName = jsonObject["fieldName"];
- result._lightName = jsonObject["lightName"];
- result._value = _bytesFromBase64(jsonObject["value"]);
- result._fieldRect = Rect.fromJson(jsonObject["fieldRect"]);
-
- return result;
-}
-Light type.
-Lights get light => _light;
-Light symbolic name.
-String get lightName => _lightName;
-Original page index.
-int get originalPageIndex => _originalPageIndex;
-An index of the document page whence the graphic field is extracted.
-int get pageIndex => _pageIndex;
-Identifies zone whence data is extracted.
-ResultType get sourceType => _sourceType;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "sourceType": sourceType.value,
- "fieldType": fieldType.value,
- "fieldName": fieldName,
- "light": light.value,
- "lightName": lightName,
- "pageIndex": pageIndex,
- "originalPageIndex": originalPageIndex,
- "value": _bytesToBase64(value),
- "fieldRect": fieldRect?.toJson(),
- }.clearNulls();
-An image.
-Uint8List? get value => _value;
-Enumeration contains identifiers that determine the logical type -of the graphic data obtained while reading the document filling fields or barcodes.
-Will be returned if getByValue if a non-existent was passed.
- - -GraphicFieldType(-1)
- Photo of the document owner.
- - -GraphicFieldType(201)
- Fingerprint of the document owner.
- - -GraphicFieldType(202)
- Iris of the document owner.
- - -GraphicFieldType(203)
- Signature of the document owner.
- - -GraphicFieldType(204)
- Barcode image.
- - -GraphicFieldType(205)
- Image of the citizenship proving document.
- - -GraphicFieldType(206)
- Document image.
- - -GraphicFieldType(207)
- Color dynamic area in the document.
- - -GraphicFieldType(209)
- Ghost portrait.
- - -GraphicFieldType(210)
- Stamp.
- - -GraphicFieldType(211)
- Portrait of child.
- - -GraphicFieldType(212)
- Contact chip.
- - -GraphicFieldType(213)
- Other image type.
- - -GraphicFieldType(250)
- Fingerprint, left thumb.
- - -GraphicFieldType(300)
- Fingerprint, left index.
- - -GraphicFieldType(301)
- Fingerprint, left middle.
- - -GraphicFieldType(302)
- Fingerprint, left ring.
- - -GraphicFieldType(303)
- Fingerprint, left little.
- - -GraphicFieldType(304)
- Fingerprint, right thumb.
- - -GraphicFieldType(305)
- Fingerprint, right index.
- - -GraphicFieldType(306)
- Fingerprint, right middle.
- - -GraphicFieldType(307)
- Fingerprint, right ring.
- - -GraphicFieldType(308)
- Fingerprint, right little.
- - -GraphicFieldType(309)
- [UNKNOWN, PORTRAIT, FINGERPR, EYE, SIGNATURE, BAR_CODE, PROOF_OF_CITIZENSHIP, DOCUMENT_IMAGE, COLOR_DYNAMIC, GHOST_PORTRAIT, STAMP, PORTRAIT_OF_CHILD, CONTACT_CHIP, OTHER, FINGER_LEFT_THUMB, FINGER_LE…
- const GraphicFieldType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Structure, containing all graphic fields extracted.
-An array of graphic results.
-List<GraphicField> get fields => _fields;
-Allows you to deserialize object.
-static GraphicResult? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = GraphicResult();
-
- for (var item in jsonObject["fields"])
- result._fields.addSafe(GraphicField.fromJson(item));
-
- return result;
-}
-ImageFormat(0)
- ImageFormat(1)
- [PNG, JPG]
- const ImageFormat
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-@visibleForTesting
-static ImageInputData? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = ImageInputData(_bytesFromBase64(jsonObject["image"])!);
-
- result._pageIndex = jsonObject["pageIndex"];
- result._light = Lights.getByValue(jsonObject["light"])!;
-
- return result;
-}
-An image.
-Uint8List get image => _image;
-Light type, one of RGLGraphicFieldLight values.
-Lights get light => _light;
-An index of the document page whence the graphic field is extracted.
-int get pageIndex => _pageIndex;
-Class contains properties to configure image quality.
-DocumentReaderResults.imageQuality.imageQualityList.result field.
- This parameter sets threshold for Image QA check of the presented -document perspective angle in degrees. If actual document perspective -angle is above this threshold, check will fail.
-int? get angleThreshold => _angleThreshold;
-set angleThreshold(int? val) {
- _angleThreshold = val;
- _set({"angleThreshold": val});
-}
-Set the threshold for an actual document brightness below which the check fails.
-double? get brightnessThreshold => _brightnessThreshold;
-set brightnessThreshold(double? val) {
- _brightnessThreshold = val;
- _set({"brightnessThreshold": val});
-}
-This option disabled colorness check during performing image quality validation.
-bool? get colornessCheck => _colornessCheck;
-set colornessCheck(bool? val) {
- _colornessCheck = val;
- _set({"colornessCheck": val});
-}
-Specify the minimum indent from the corners of the document to the borders
-of the image. The value reflects the allowed percentage for the indent
-relative to the width of the document. If it is detected that the corners
-of the document are closer than the specified value, the status will contain
-an error in the DocumentReaderResults.imageQuality.imageQualityList.result field.
int? get documentPositionIndent => _documentPositionIndent;
-set documentPositionIndent(int? val) {
- _documentPositionIndent = val;
- _set({"documentPositionIndent": val});
-}
-This parameter sets threshold for Image QA check of the presented -document physical dpi. If actual document dpi is below this threshold, -check will fail.
-int? get dpiThreshold => _dpiThreshold;
-set dpiThreshold(int? val) {
- _dpiThreshold = val;
- _set({"dpiThreshold": val});
-}
-This option controls the quality checks that the image should pass -in order to be considered a valid input during the scanning process.
-List<ImageQualityCheckType>? get expectedPass => _expectedPass;
-set expectedPass(List<ImageQualityCheckType>? val) {
- _expectedPass = val;
- _set({"expectedPass": val?.map((e) => e.value).toList()});
-}
-This option disabled focus check during performing image quality validation.
-bool? get focusCheck => _focusCheck;
-set focusCheck(bool? val) {
- _focusCheck = val;
- _set({"focusCheck": val});
-}
-Allows you to deserialize object.
-static ImageQA fromJson(jsonObject) {
- var result = ImageQA();
- result.testSetters = {};
-
- result.dpiThreshold = jsonObject["dpiThreshold"];
- result.angleThreshold = jsonObject["angleThreshold"];
- result.focusCheck = jsonObject["focusCheck"];
- result.glaresCheck = jsonObject["glaresCheck"];
- result.colornessCheck = jsonObject["colornessCheck"];
- result.screenCapture = jsonObject["screenCapture"];
- result.expectedPass =
- ImageQualityCheckType.fromIntList(jsonObject["expectedPass"]);
- result.glaresCheckParams =
- GlaresCheckParams.fromJson(jsonObject["glaresCheckParams"]);
- result.documentPositionIndent = jsonObject["documentPositionIndent"];
- result.brightnessThreshold = _toDouble(jsonObject["brightnessThreshold"]);
-
- return result;
-}
-This option disabled glares check during performing image quality validation.
-bool? get glaresCheck => _glaresCheck;
-set glaresCheck(bool? val) {
- _glaresCheck = val;
- _set({"glaresCheck": val});
-}
-Parameters for glares image quality validation.
-GlaresCheckParams? get glaresCheckParams => _glaresCheckParams;
-set glaresCheckParams(GlaresCheckParams? val) {
- _glaresCheckParams = val;
- _set({"glaresCheckParams": val?.toJson()});
-}
-This option disabled moire patterns check during performing image quality validation.
-bool? get screenCapture => _screenCapture;
-set screenCapture(bool? val) {
- _screenCapture = val;
- _set({"screenCapture": val});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "dpiThreshold": dpiThreshold,
- "angleThreshold": angleThreshold,
- "documentPositionIndent": documentPositionIndent,
- "focusCheck": focusCheck,
- "glaresCheck": glaresCheck,
- "colornessCheck": colornessCheck,
- "screenCapture": screenCapture,
- "expectedPass": expectedPass?.map((e) => e.value).toList(),
- "glaresCheckParams": glaresCheckParams?.toJson(),
- "brightnessThreshold": brightnessThreshold,
- }.clearNulls();
-Structure, containing information about single image quality check.
-Check result.
-int get featureType => _featureType;
-Allows you to deserialize object.
-static ImageQuality? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = ImageQuality();
-
- result._featureType = jsonObject["featureType"];
- result._result = CheckResult.getByValue(jsonObject["result"])!;
- result._type = ImageQualityCheckType.getByValue(jsonObject["type"])!;
- for (var item in jsonObject["boundRects"])
- result._boundRects.addSafe(Rect.fromJson(item));
-
- return result;
-}
-Check result.
-CheckResult get result => _result;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "featureType": featureType,
- "result": result.value,
- "type": type.value,
- "boundRects": boundRects.map((e) => e.toJson()).toList(),
- }.clearNulls();
-Check result type.
-ImageQualityCheckType get type => _type;
-Will be returned if getByValue if a non-existent was passed.
- - -ImageQualityCheckType(-1)
- Glares presence check.
- - -ImageQualityCheckType(0)
- Focus quality check.
- - -ImageQualityCheckType(1)
- Image resolution check.
- - -ImageQualityCheckType(2)
- Image colorness check.
- - -ImageQualityCheckType(3)
- Image perspective check, i.e. the deviation of the corners of the document -from the value of 90 degrees is checked.
- - -ImageQualityCheckType(4)
- Image quality check if the whole document page is completely within the image.
- - -ImageQualityCheckType(5)
- Image moire check.
- - -ImageQualityCheckType(6)
- Portrait image check.
- - -ImageQualityCheckType(7)
- Handwritten image check.
- - -ImageQualityCheckType(8)
- Signals whether the document image is bright enough.
- - -ImageQualityCheckType(9)
- [UNKNOWN, IMAGE_GLARES, IMAGE_FOCUS, IMAGE_RESOLUTION, IMAGE_COLORNESS, PERSPECTIVE, BOUNDS, SCREEN_CAPTURE, PORTRAIT, HANDWRITTEN, BRIGHTNESS]
- const ImageQualityCheckType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Structure, containing overall data about quality checks performed.
-Number of results.
-int get count => _count;
-Allows you to deserialize object.
-static ImageQualityGroup? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = ImageQualityGroup();
-
- result._count = jsonObject["count"];
- result._result = CheckResult.getByValue(jsonObject["result"])!;
- result._pageIndex = jsonObject["pageIndex"];
- for (var item in jsonObject["imageQualityList"])
- result._imageQualityList.addSafe(ImageQuality.fromJson(item));
-
- return result;
-}
-An array of single check result pointers.
-List<ImageQuality> get imageQualityList => _imageQualityList;
-Index of the document page, whence the result is received.
-int get pageIndex => _pageIndex;
-Overall check result for document page.
-CheckResult get result => _result;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "count": count,
- "result": result.value,
- "pageIndex": pageIndex,
- "imageQualityList": imageQualityList.map((e) => e.toJson()).toList(),
- }.clearNulls();
-A configuration file for DocumentReader initialization. -Controls initialization time properties such as licenseUpdate and delayedNNLoad.
-Constructor for initialization using a license binary.
-InitConfig
-Constructor for initialization using a ble device. -Doesn't need a license file, it will be fetched automatically from your ble device.
-Android only.
-InitConfig.withBleDevice() : _license = ByteData(0) {
- if (!Platform.isAndroid)
- throw PlatformException(
- code: "android-only",
- message: "withBleDevice constructor is accessible only on Android",
- );
- _useBleDevice = true;
-}
-Custom database binary.
-Android only. For iOS use databasePath.
-ByteData? customDb;
-Defines whether the DocumentReader delays loading of neural networks.
-When set to true the initialization starts in the background thread after
-the method DocumentReader.initializeReader is called. If the document
-processing is initiated before all the networks are loaded,
-the DocumentReader will wait for it before starting the handling.
When set to false the initialization is performed during
-DocumentReader.initializeReader method.
bool delayedNNLoad = false;
-@visibleForTesting
-static InitConfig? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = InitConfig(_dataFromBase64(jsonObject["license"])!);
-
- result.customDb = _dataFromBase64(jsonObject["customDb"]);
- result.delayedNNLoad = jsonObject["delayedNNLoad"];
- result.licenseUpdate = jsonObject["licenseUpdate"];
- result.blackList = jsonObject["blackList"];
- result.databasePath = jsonObject["databasePath"];
-
- return result;
-}
-The license binary file.
-ByteData get license => _license;
-Enables automatic license update check during DocumentReader initialization.
-bool licenseUpdate = true;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "license": _dataToBase64(license),
- "delayedNNLoad": delayedNNLoad,
- "licenseUpdate": licenseUpdate,
- "blackList": blackList,
- "customDb": _dataToBase64(customDb),
- "databasePath": databasePath
- }.clearNulls();
-Enumeration contains a language ID that identifies a particular language.
-Will be returned if getByValue if a non-existent was passed.
- - -LCID(-1)
- LCID(0)
- LCID(10011)
- LCID(1078)
- LCID(1052)
- LCID(1118)
- LCID(5121)
- LCID(15361)
- LCID(3073)
- LCID(2049)
- LCID(11265)
- LCID(13313)
- LCID(12289)
- LCID(4097)
- LCID(6145)
- LCID(8193)
- LCID(16385)
- LCID(1025)
- LCID(10241)
- LCID(7169)
- LCID(14337)
- LCID(9217)
- LCID(1067)
- LCID(4096)
- LCID(2092)
- LCID(1068)
- LCID(1101)
- LCID(1069)
- LCID(10003)
- LCID(10004)
- LCID(10002)
- LCID(10000)
- LCID(10001)
- LCID(1059)
- LCID(2117)
- LCID(1093)
- LCID(1026)
- LCID(1027)
- LCID(3076)
- LCID(5124)
- LCID(2052)
- LCID(4100)
- LCID(1028)
- LCID(1050)
- LCID(1029)
- LCID(1030)
- LCID(1125)
- LCID(2067)
- LCID(1043)
- LCID(3081)
- LCID(10249)
- LCID(4105)
- LCID(9225)
- LCID(6153)
- LCID(8201)
- LCID(5129)
- LCID(13321)
- LCID(7177)
- LCID(11273)
- LCID(2057)
- LCID(1033)
- LCID(12297)
- LCID(1061)
- LCID(1080)
- LCID(1065)
- LCID(1035)
- LCID(2060)
- LCID(3084)
- LCID(1036)
- LCID(5132)
- LCID(6156)
- LCID(4108)
- LCID(1071)
- LCID(1110)
- LCID(1079)
- LCID(3079)
- LCID(1031)
- LCID(5127)
- LCID(4103)
- LCID(2055)
- LCID(1032)
- LCID(1095)
- LCID(1037)
- LCID(1081)
- LCID(1038)
- LCID(1039)
- LCID(1057)
- LCID(1040)
- LCID(2064)
- LCID(1041)
- LCID(1099)
- LCID(1120)
- LCID(1087)
- LCID(1111)
- LCID(1042)
- LCID(1088)
- LCID(1108)
- LCID(1062)
- LCID(1063)
- LCID(1086)
- LCID(2110)
- LCID(1102)
- LCID(1104)
- LCID(1044)
- LCID(2068)
- LCID(1123)
- LCID(1045)
- LCID(1046)
- LCID(2070)
- LCID(1094)
- LCID(1047)
- LCID(1048)
- LCID(1049)
- LCID(1103)
- LCID(3098)
- LCID(2074)
- LCID(2137)
- LCID(1113)
- LCID(1115)
- LCID(1051)
- LCID(1060)
- LCID(11274)
- LCID(16394)
- LCID(13322)
- LCID(9226)
- LCID(5130)
- LCID(7178)
- LCID(12298)
- LCID(17418)
- LCID(4106)
- LCID(18442)
- LCID(2058)
- LCID(19466)
- LCID(6154)
- LCID(15370)
- LCID(10250)
- LCID(20490)
- LCID(1034)
- LCID(3082)
- LCID(14346)
- LCID(8202)
- LCID(1089)
- LCID(1053)
- LCID(2077)
- LCID(1114)
- LCID(1097)
- LCID(1092)
- LCID(1098)
- LCID(1054)
- LCID(1055)
- LCID(1064)
- LCID(1090)
- LCID(1058)
- LCID(1056)
- LCID(2115)
- LCID(1091)
- LCID(1066)
- LCID(50001)
- LCID(50002)
- LCID(1082)
- LCID(1109)
- LCID(1107)
- LCID(10012)
- LCID(1100)
- LCID(1121)
- LCID(1096)
- LCID(10560)
- [UNKNOWN, LATIN, ABKHAZIAN_CYRILLIC, AFRIKAANS, ALBANIAN, AMHARIC, ARABIC_ALGERIA, ARABIC_BAHRAIN, ARABIC_EGYPT, ARABIC_IRAQ, ARABIC_JORDAN, ARABIC_KUWAIT, ARABIC_LEBANON, ARABIC_LIBYA, ARABIC_MOROCCO…
- const LCID
-final int value;
-Will be returned if getByValue if a non-existent was passed.
- - -LDSParsingErrorCodes(-1)
- LDSParsingErrorCodes(0x00000001)
- LDSParsingErrorCodes(0x80000001)
- LDSParsingErrorCodes(0x80000002)
- LDSParsingErrorCodes(0x80000003)
- LDSParsingErrorCodes(0x80000008)
- LDSParsingErrorCodes(0x80000009)
- LDSParsingErrorCodes(0x8000000A)
- LDSParsingErrorCodes(0x80000011)
- LDSParsingErrorCodes(0x80000013)
- LDSParsingErrorCodes(0x80000014)
- LDSParsingErrorCodes(0x80000015)
- LDSParsingErrorCodes(0x80000016)
- LDSParsingErrorCodes(0x80000012)
- LDSParsingErrorCodes(0x80000017)
- LDSParsingErrorCodes(0x80000018)
- LDSParsingErrorCodes(0x80000019)
- LDSParsingErrorCodes(0x8000001A)
- LDSParsingErrorCodes(0x8000001B)
- LDSParsingErrorCodes(0x8000001C)
- LDSParsingErrorCodes(0x8000001D)
- LDSParsingErrorCodes(0x8000001E)
- LDSParsingErrorCodes(0x8000001F)
- LDSParsingErrorCodes(0x80000020)
- LDSParsingErrorCodes(0x80000021)
- LDSParsingErrorCodes(0x80000022)
- LDSParsingErrorCodes(0x80000023)
- LDSParsingErrorCodes(0x80000024)
- LDSParsingErrorCodes(0x80000025)
- LDSParsingErrorCodes(0x80000026)
- LDSParsingErrorCodes(0x80000027)
- LDSParsingErrorCodes(0x80000030)
- LDSParsingErrorCodes(0x80000031)
- LDSParsingErrorCodes(0x80000032)
- LDSParsingErrorCodes(0x80000033)
- LDSParsingErrorCodes(0x80000034)
- LDSParsingErrorCodes(0x80000036)
- LDSParsingErrorCodes(0x80000035)
- LDSParsingErrorCodes(0x80000050)
- LDSParsingErrorCodes(0x80000051)
- LDSParsingErrorCodes(0x80000052)
- LDSParsingErrorCodes(0x80000053)
- LDSParsingErrorCodes(0x80000054)
- LDSParsingErrorCodes(0x80000055)
- LDSParsingErrorCodes(0x80000056)
- LDSParsingErrorCodes(0x80000057)
- LDSParsingErrorCodes(0x80000058)
- LDSParsingErrorCodes(0x80000059)
- LDSParsingErrorCodes(0x8000005A)
- LDSParsingErrorCodes(0x80000070)
- LDSParsingErrorCodes(0x80000071)
- LDSParsingErrorCodes(0x81000011)
- LDSParsingErrorCodes(0x81000020)
- LDSParsingErrorCodes(0x81000021)
- LDSParsingErrorCodes(0x81000022)
- LDSParsingErrorCodes(0x81000023)
- LDSParsingErrorCodes(0x81000024)
- LDSParsingErrorCodes(0x81000025)
- LDSParsingErrorCodes(0x81000026)
- LDSParsingErrorCodes(0x81000027)
- LDSParsingErrorCodes(0x81000028)
- LDSParsingErrorCodes(0x81000029)
- LDSParsingErrorCodes(0x8100002A)
- LDSParsingErrorCodes(0x8100002B)
- LDSParsingErrorCodes(0x8100002C)
- LDSParsingErrorCodes(0x8100002D)
- LDSParsingErrorCodes(0x8100002E)
- LDSParsingErrorCodes(0x8100002F)
- LDSParsingErrorCodes(0x81000030)
- LDSParsingErrorCodes(0x81000031)
- LDSParsingErrorCodes(0x81000032)
- LDSParsingErrorCodes(0x81000033)
- LDSParsingErrorCodes(0x81000034)
- LDSParsingErrorCodes(0x81000035)
- LDSParsingErrorCodes(0x81000036)
- LDSParsingErrorCodes(0x81000037)
- LDSParsingErrorCodes(0x81000038)
- LDSParsingErrorCodes(0x81000040)
- LDSParsingErrorCodes(0x81000041)
- LDSParsingErrorCodes(0x81000042)
- LDSParsingErrorCodes(0x81000043)
- LDSParsingErrorCodes(0x81000044)
- LDSParsingErrorCodes(0x81000045)
- LDSParsingErrorCodes(0x81000050)
- LDSParsingErrorCodes(0x81000051)
- LDSParsingErrorCodes(0x81000052)
- LDSParsingErrorCodes(0x81000053)
- LDSParsingErrorCodes(0x81000054)
- LDSParsingErrorCodes(0x81000055)
- LDSParsingErrorCodes(0x81000056)
- LDSParsingErrorCodes(0x81000057)
- LDSParsingErrorCodes(0x81000070)
- LDSParsingErrorCodes(0x81000071)
- LDSParsingErrorCodes(0x81000072)
- LDSParsingErrorCodes(0x81000060)
- LDSParsingErrorCodes(0x81000062)
- LDSParsingErrorCodes(0x81000063)
- LDSParsingErrorCodes(0x8100006)
- LDSParsingErrorCodes(0x81000065)
- LDSParsingErrorCodes(0x81000160)
- LDSParsingErrorCodes(0x81000161)
- LDSParsingErrorCodes(0x81000162)
- LDSParsingErrorCodes(0x81000163)
- LDSParsingErrorCodes(0x81000164)
- LDSParsingErrorCodes(0x81000165)
- LDSParsingErrorCodes(0x81000166)
- LDSParsingErrorCodes(0x81000167)
- LDSParsingErrorCodes(0x81000168)
- LDSParsingErrorCodes(0x81000169)
- LDSParsingErrorCodes(0x8100016A)
- LDSParsingErrorCodes(0x81000200)
- LDSParsingErrorCodes(0x81000201)
- LDSParsingErrorCodes(0x81000202)
- LDSParsingErrorCodes(0x81000203)
- LDSParsingErrorCodes(0x81000204)
- LDSParsingErrorCodes(0x81000205)
- LDSParsingErrorCodes(0x81000300)
- LDSParsingErrorCodes(0x81000301)
- LDSParsingErrorCodes(0x81000302)
- LDSParsingErrorCodes(0x81000303)
- LDSParsingErrorCodes(0x81000304)
- LDSParsingErrorCodes(0x81000305)
- LDSParsingErrorCodes(0x81000306)
- LDSParsingErrorCodes(0x81000307)
- LDSParsingErrorCodes(0x81000308)
- LDSParsingErrorCodes(0x81000309)
- LDSParsingErrorCodes(0x8100030A)
- [UNKNOWN, OK, ASN_INCORRECT_DATA, ASN_NOT_ENOUGH_DATA, ASN_CONTENTS_UNEXPECTED_DATA, ASN_SIGNED_DATA_INCORRECT_DATA, ASN_SIGNED_DATA_ENCAP_CONTENTS_INCORRECT_DATA, ASN_SIGNED_DATA_VERSION_INCORRECT_DA…
- const LDSParsingErrorCodes
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Will be returned if getByValue if a non-existent was passed.
- - -LDSParsingNotificationCodes(-1)
- LDSParsingNotificationCodes(0x90000001)
- LDSParsingNotificationCodes(0x90000002)
- LDSParsingNotificationCodes(0x90000003)
- LDSParsingNotificationCodes(0x90000004)
- LDSParsingNotificationCodes(0x90000005)
- LDSParsingNotificationCodes(0x90000006)
- LDSParsingNotificationCodes(0x90000008)
- LDSParsingNotificationCodes(0x9000000E)
- LDSParsingNotificationCodes(0x9000000F)
- LDSParsingNotificationCodes(0x90000010)
- LDSParsingNotificationCodes(0x90000017)
- LDSParsingNotificationCodes(0x90000200)
- LDSParsingNotificationCodes(0x90000201)
- LDSParsingNotificationCodes(0x90000202)
- LDSParsingNotificationCodes(0x90000203)
- LDSParsingNotificationCodes(0x90000204)
- LDSParsingNotificationCodes(0x90000205)
- LDSParsingNotificationCodes(0x90000206)
- LDSParsingNotificationCodes(0x90000207)
- LDSParsingNotificationCodes(0x90000208)
- LDSParsingNotificationCodes(0x90000209)
- LDSParsingNotificationCodes(0x9000020A)
- LDSParsingNotificationCodes(0x9000020B)
- LDSParsingNotificationCodes(0x9000020C)
- LDSParsingNotificationCodes(0x9000020D)
- LDSParsingNotificationCodes(0x9000020E)
- LDSParsingNotificationCodes(0x9000020F)
- LDSParsingNotificationCodes(0x90000210)
- LDSParsingNotificationCodes(0x90000211)
- LDSParsingNotificationCodes(0x90000212)
- LDSParsingNotificationCodes(0x90000213)
- LDSParsingNotificationCodes(0x90000214)
- LDSParsingNotificationCodes(0x90000215)
- LDSParsingNotificationCodes(0x90000216)
- LDSParsingNotificationCodes(0x90000217)
- LDSParsingNotificationCodes(0x90000218)
- LDSParsingNotificationCodes(0x90000219)
- LDSParsingNotificationCodes(0x9000021A)
- LDSParsingNotificationCodes(0x9000021B)
- LDSParsingNotificationCodes(0x9000021C)
- LDSParsingNotificationCodes(0x9000021D)
- LDSParsingNotificationCodes(0x9000021E)
- LDSParsingNotificationCodes(0x9000021F)
- LDSParsingNotificationCodes(0x90000220)
- LDSParsingNotificationCodes(0x90000221)
- LDSParsingNotificationCodes(0x90000222)
- LDSParsingNotificationCodes(0x90000223)
- LDSParsingNotificationCodes(0x90000224)
- LDSParsingNotificationCodes(0x90000225)
- LDSParsingNotificationCodes(0x90000226)
- LDSParsingNotificationCodes(0x90000228)
- LDSParsingNotificationCodes(0x90000229)
- LDSParsingNotificationCodes(0x9000022A)
- LDSParsingNotificationCodes(0x9000022B)
- LDSParsingNotificationCodes(0x9000022C)
- LDSParsingNotificationCodes(0x9000022D)
- LDSParsingNotificationCodes(0x9000022E)
- LDSParsingNotificationCodes(0x9000022F)
- LDSParsingNotificationCodes(0x90000231)
- LDSParsingNotificationCodes(0x90000232)
- LDSParsingNotificationCodes(0x90000233)
- LDSParsingNotificationCodes(0x90000234)
- LDSParsingNotificationCodes(0x90000235)
- LDSParsingNotificationCodes(0x90000236)
- LDSParsingNotificationCodes(0x90000237)
- LDSParsingNotificationCodes(0x90000238)
- LDSParsingNotificationCodes(0x90000239)
- LDSParsingNotificationCodes(0x9000023A)
- LDSParsingNotificationCodes(0x9000023B)
- LDSParsingNotificationCodes(0x9000023C)
- LDSParsingNotificationCodes(0x9000023D)
- LDSParsingNotificationCodes(0x9000023E)
- LDSParsingNotificationCodes(0x9000023F)
- LDSParsingNotificationCodes(0x90000240)
- LDSParsingNotificationCodes(0x90000241)
- LDSParsingNotificationCodes(0x90000242)
- LDSParsingNotificationCodes(0x90000243)
- LDSParsingNotificationCodes(0x90000244)
- LDSParsingNotificationCodes(0x90000245)
- LDSParsingNotificationCodes(0x90000246)
- LDSParsingNotificationCodes(0x90000247)
- LDSParsingNotificationCodes(0x90000248)
- LDSParsingNotificationCodes(0x90000249)
- LDSParsingNotificationCodes(0x9000024A)
- LDSParsingNotificationCodes(0x9000024B)
- LDSParsingNotificationCodes(0x9000024C)
- LDSParsingNotificationCodes(0x9000024D)
- LDSParsingNotificationCodes(0x9000024E)
- LDSParsingNotificationCodes(0x9000024F)
- LDSParsingNotificationCodes(0x90000020)
- LDSParsingNotificationCodes(0x90000021)
- LDSParsingNotificationCodes(0x90000022)
- LDSParsingNotificationCodes(0x90000023)
- LDSParsingNotificationCodes(0x90000024)
- LDSParsingNotificationCodes(0x90000025)
- LDSParsingNotificationCodes(0x90000026)
- LDSParsingNotificationCodes(0x90000030)
- LDSParsingNotificationCodes(0x90000031)
- LDSParsingNotificationCodes(0x90000032)
- LDSParsingNotificationCodes(0x90000033)
- LDSParsingNotificationCodes(0x90000100)
- LDSParsingNotificationCodes(0x900001A0)
- LDSParsingNotificationCodes(0x900001A1)
- LDSParsingNotificationCodes(0x90000101)
- LDSParsingNotificationCodes(0x90000102)
- LDSParsingNotificationCodes(0x90000103)
- LDSParsingNotificationCodes(0x90000109)
- LDSParsingNotificationCodes(0x900001B0)
- LDSParsingNotificationCodes(0x900001B1)
- LDSParsingNotificationCodes(0x900001B2)
- LDSParsingNotificationCodes(0x90000104)
- LDSParsingNotificationCodes(0x90000105)
- LDSParsingNotificationCodes(0x90000106)
- LDSParsingNotificationCodes(0x90000107)
- LDSParsingNotificationCodes(0x90000108)
- LDSParsingNotificationCodes(0x900001C0)
- LDSParsingNotificationCodes(0x900001C8)
- LDSParsingNotificationCodes(0x900001D0)
- LDSParsingNotificationCodes(0x900001D8)
- LDSParsingNotificationCodes(0x9000010A)
- LDSParsingNotificationCodes(0x9000010B)
- LDSParsingNotificationCodes(0x9000010C)
- LDSParsingNotificationCodes(0x9000010D)
- LDSParsingNotificationCodes(0x9000010E)
- LDSParsingNotificationCodes(0x9000010F)
- LDSParsingNotificationCodes(0x90000110)
- LDSParsingNotificationCodes(0x90000111)
- LDSParsingNotificationCodes(0x90000112)
- LDSParsingNotificationCodes(0x9000011B)
- LDSParsingNotificationCodes(0x9000011C)
- LDSParsingNotificationCodes(0x9000011D)
- LDSParsingNotificationCodes(0x9000011E)
- LDSParsingNotificationCodes(0x9000011F)
- LDSParsingNotificationCodes(0x90000115)
- LDSParsingNotificationCodes(0x90000116)
- LDSParsingNotificationCodes(0x90000117)
- LDSParsingNotificationCodes(0x90000118)
- LDSParsingNotificationCodes(0x90000119)
- LDSParsingNotificationCodes(0x9000011A)
- LDSParsingNotificationCodes(0x00022008)
- LDSParsingNotificationCodes(0x00022009)
- LDSParsingNotificationCodes(0x0002200A)
- LDSParsingNotificationCodes(0x0002200D)
- LDSParsingNotificationCodes(0x0002200E)
- LDSParsingNotificationCodes(0x0002200F)
- LDSParsingNotificationCodes(0x00022010)
- LDSParsingNotificationCodes(0x00022011)
- LDSParsingNotificationCodes(0x00022012)
- LDSParsingNotificationCodes(0x00022013)
- LDSParsingNotificationCodes(0x00022014)
- LDSParsingNotificationCodes(0x00022015)
- LDSParsingNotificationCodes(0x00022016)
- LDSParsingNotificationCodes(0x00022017)
- LDSParsingNotificationCodes(0x00022018)
- LDSParsingNotificationCodes(0x90010000)
- LDSParsingNotificationCodes(0x90020000)
- LDSParsingNotificationCodes(0x90030000)
- LDSParsingNotificationCodes(0x90040000)
- LDSParsingNotificationCodes(0x90050000)
- LDSParsingNotificationCodes(0x90060000)
- LDSParsingNotificationCodes(0x90070000)
- LDSParsingNotificationCodes(0x90080000)
- LDSParsingNotificationCodes(0x90090000)
- LDSParsingNotificationCodes(0x900A0000)
- LDSParsingNotificationCodes(0x900B0000)
- LDSParsingNotificationCodes(0x90100000)
- LDSParsingNotificationCodes(0x90110000)
- LDSParsingNotificationCodes(0x90120000)
- LDSParsingNotificationCodes(0x90130000)
- LDSParsingNotificationCodes(0x90140000)
- LDSParsingNotificationCodes(0x90150000)
- LDSParsingNotificationCodes(0x90160000)
- LDSParsingNotificationCodes(0x90170000)
- LDSParsingNotificationCodes(0x90180000)
- LDSParsingNotificationCodes(0x90190000)
- LDSParsingNotificationCodes(0x901A0000)
- LDSParsingNotificationCodes(0x91000000)
- LDSParsingNotificationCodes(0x91000001)
- LDSParsingNotificationCodes(0x91000002)
- LDSParsingNotificationCodes(0x91000003)
- LDSParsingNotificationCodes(0x91000004)
- LDSParsingNotificationCodes(0x91000005)
- LDSParsingNotificationCodes(0x91000006)
- LDSParsingNotificationCodes(0x91000007)
- LDSParsingNotificationCodes(0x91000008)
- LDSParsingNotificationCodes(0x91000009)
- LDSParsingNotificationCodes(0x9100000A)
- LDSParsingNotificationCodes(0x9100000B)
- LDSParsingNotificationCodes(0x9100000C)
- LDSParsingNotificationCodes(0x9100000D)
- LDSParsingNotificationCodes(0x9100000E)
- LDSParsingNotificationCodes(0x91000100)
- LDSParsingNotificationCodes(0x91000101)
- LDSParsingNotificationCodes(0x91000102)
- LDSParsingNotificationCodes(0x91000103)
- LDSParsingNotificationCodes(0x91000104)
- LDSParsingNotificationCodes(0x91000105)
- LDSParsingNotificationCodes(0x91000106)
- LDSParsingNotificationCodes(0x91000107)
- LDSParsingNotificationCodes(0x91000108)
- LDSParsingNotificationCodes(0x91000109)
- LDSParsingNotificationCodes(0x9100010A)
- LDSParsingNotificationCodes(0x9100010B)
- LDSParsingNotificationCodes(0x9100010C)
- LDSParsingNotificationCodes(0x9100010D)
- LDSParsingNotificationCodes(0x9100010E)
- LDSParsingNotificationCodes(0x9100010F)
- LDSParsingNotificationCodes(0x91000110)
- LDSParsingNotificationCodes(0x91000201)
- LDSParsingNotificationCodes(0x91000202)
- LDSParsingNotificationCodes(0x91000203)
- LDSParsingNotificationCodes(0x91000204)
- LDSParsingNotificationCodes(0x91000300)
- LDSParsingNotificationCodes(0x92000115)
- LDSParsingNotificationCodes(0x92000116)
- LDSParsingNotificationCodes(0x92000117)
- LDSParsingNotificationCodes(0x92000118)
- LDSParsingNotificationCodes(0x92000119)
- LDSParsingNotificationCodes(0x90000250)
- LDSParsingNotificationCodes(0x90000251)
- LDSParsingNotificationCodes(0x00022019)
- LDSParsingNotificationCodes(0x90000252)
- [UNKNOWN, ASN_CERTIFICATE_INCORRECT_VERSION, ASN_CERTIFICATE_NON_MATCHING_SIGNATURE_ALGORITHM, ASN_CERTIFICATE_INCORRECT_TIME_CODING, ASN_CERTIFICATE_INCORRECT_USE_OF_GENERALIZED_TIME, ASN_CERTIFICATE…
- const LDSParsingNotificationCodes
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Class contains properties to get the information about the license.
-Allows you to get a list of country identifiers which are defined for -processing in the license. If the array is empty, there are no -restrictions for processing.
-List<String>? get countryFilter => _countryFilter;
-Allows you to get an expiration date of your license.
-String? get expiryDate => _expiryDate;
-@visibleForTesting
-static License? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = License();
-
- result._expiryDate = jsonObject["expiryDate"];
- result._countryFilter = jsonObject["countryFilter"] == null
- ? null
- : List<String>.from(jsonObject["countryFilter"]);
- result._isRfidAvailable = jsonObject["isRfidAvailable"];
-
- return result;
-}
-Allows you to verify that RFID chip reading capabilities are added to your license.
-bool get isRfidAvailable => _isRfidAvailable;
-Enumeration contains a set of identifiers used for identifying the -document reader possibilities, specifying lighting schemes for scanning, etc.
-Will be returned if getByValue if a non-existent was passed.
- - -Lights(-1)
- Light off.
- - -Lights(0)
- General UV light scheme.
- - -Lights(128)
- General white light scheme.
- - -Lights(6)
- Lights(16777216)
- Upper/lower lighters of IR light scheme.
- - -Lights(8)
- Side lighters of IR light scheme.
- - -Lights(16)
- Upper/lower and side lighters of IR light scheme.
- - -Lights((8 | 16))
- OVD light for hologram visualization.
- - -Lights(67108864)
- Combined light for WHITE_FULL and OVD.
- - -Lights(6 | 67108864)
- const Lights
-final int value;
-bool? get checkHolo => _checkHolo;
-set checkHolo(bool? val) {
- _checkHolo = val;
- _set({"checkHolo": val});
-}
-Allows you to deserialize object.
-static LivenessParams fromJson(jsonObject) {
- if (jsonObject == null) return LivenessParams();
- var result = LivenessParams();
- result.testSetters = {};
-
- result.checkOVI = jsonObject["checkOVI"];
- result.checkMLI = jsonObject["checkMLI"];
- result.checkHolo = jsonObject["checkHolo"];
- result.checkED = jsonObject["checkED"];
-
- return result;
-}
-Will be returned if getByValue if a non-existent was passed.
- - -MRZFormat("")
- MRZFormat("1x30")
- MRZFormat("3x30")
- MRZFormat("2x36")
- MRZFormat("2x44")
- MRZFormat("1x6")
- MRZFormat("2x30")
- const MRZFormat
-final String value;
-The constants of the enumeration identify the system -for measuring distances and weight.
-The Metric System of Measurement, which uses the measuring units -such as meters and grams and adds prefixes like kilo, milli -and centi to count orders of magnitude.
- - -MeasureSystem(0)
- The Imperial System of Measurement, where things are measured in feet, -inches and pounds.
- - -MeasureSystem(1)
- [METRIC, IMPERIAL]
- const MeasureSystem
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-OnlineMode(0)
- OnlineMode(1)
- [MANUAL, AUTO]
- const OnlineMode
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-OnlineProcessingConfig
-@visibleForTesting
-static OnlineProcessingConfig? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- OnlineMode mode = OnlineMode.getByValue(jsonObject["mode"])!;
- var result = OnlineProcessingConfig(mode);
-
- result.url = jsonObject["url"];
- result.imageFormat = ImageFormat.getByValue(jsonObject["imageFormat"])!;
- result.imageCompressionQuality =
- jsonObject["imageCompressionQuality"].toDouble();
- result.processParams = ProcessParams.fromJson(jsonObject["processParams"]);
-
- return result;
-}
-double imageCompressionQuality = 0.8;
-ImageFormat imageFormat = ImageFormat.JPG;
-OnlineMode mode;
-ProcessParams processParams = ProcessParams();
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "mode": mode.value,
- "url": url,
- "imageFormat": imageFormat.value,
- "imageCompressionQuality": imageCompressionQuality,
- "processParams": processParams.toJson(),
- }.clearNulls();
-String url = "https://api.regulaforensics.com";
-Container for an optical related scanning statuses.
-Check status if document type was recognized or not.
-CheckResult get docType => _docType;
-Document validity period verification status.
-CheckResult get expiry => _expiry;
-Allows you to deserialize object.
-static OpticalStatus? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = OpticalStatus();
-
- result._overallStatus =
- CheckResult.getByValue(jsonObject["overallStatus"])!;
- result._mrz = CheckResult.getByValue(jsonObject["mrz"])!;
- result._text = CheckResult.getByValue(jsonObject["text"])!;
- result._docType = CheckResult.getByValue(jsonObject["docType"])!;
- result._security = CheckResult.getByValue(jsonObject["security"])!;
- result._imageQA = CheckResult.getByValue(jsonObject["imageQA"])!;
- result._expiry = CheckResult.getByValue(jsonObject["expiry"])!;
- result._vds = CheckResult.getByValue(jsonObject["vds"])!;
- result._pagesCount = jsonObject["pagesCount"]!;
-
- return result;
-}
-Input images quality verification status.
-CheckResult get imageQA => _imageQA;
-MRZ verification: values validity, dates, checkdigits verification.
-CheckResult get mrz => _mrz;
-Summary of all optical results.
-CheckResult get overallStatus => _overallStatus;
-Number of scanned document pages.
-int get pagesCount => _pagesCount;
-Authenticity verification status.
-CheckResult get security => _security;
-Text fields valitity: values validity for specific fields, cross-comparison -of values from different sources, dates & checkdigits verification.
-CheckResult get text => _text;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "overallStatus": overallStatus.value,
- "mrz": mrz.value,
- "text": text.value,
- "docType": docType.value,
- "security": security.value,
- "imageQA": imageQA.value,
- "expiry": expiry.value,
- "vds": vds.value,
- "pagesCount": pagesCount,
- }.clearNulls();
-Visible Digital Seal verification status.
-CheckResult get vds => _vds;
-@visibleForTesting
-static PAAttribute? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = PAAttribute();
-
- result._type = jsonObject["type"] ?? "";
- result._value = jsonObject["value"] ?? "";
-
- return result;
-}
-String get type => _type;
-String get value => _value;
-List<PAAttribute> get attributes => _attributes;
-Uint8List get data => _data;
-String? get friendlyName => _friendlyName;
-@visibleForTesting
-static PAResourcesIssuer? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = PAResourcesIssuer();
-
- result._data = _bytesFromBase64(jsonObject["data"])!;
- result._friendlyName = jsonObject["friendlyName"];
- for (var item in jsonObject["attributes"])
- result._attributes.addSafe(PAAttribute.fromJson(item));
-
- return result;
-}
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "data": _bytesToBase64(data),
- "friendlyName": friendlyName,
- "attributes": attributes.map((e) => e.toJson()).toList(),
- }.clearNulls();
-Number of columns in a barcode.
-int get columns => _columns;
-Barcode error correction level.
-int get errorLevel => _errorLevel;
-Allows you to deserialize object.
-static PDF417Info? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = PDF417Info();
-
- result._errorLevel = jsonObject["errorLevel"];
- result._columns = jsonObject["columns"];
- result._rows = jsonObject["rows"];
-
- return result;
-}
-Number of rows in a barcode.
-int get rows => _rows;
-Class contains information about PKD certificate.
-PKDCertificate
-Certificate in binary type.
-ByteData get binaryData => _binaryData;
-@visibleForTesting
-static PKDCertificate? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return PKDCertificate(
- _dataFromBase64(jsonObject["binaryData"])!,
- PKDResourceType.getByValue(jsonObject["resourceType"])!,
- privateKey: _dataFromBase64(jsonObject["privateKey"]),
- );
-}
-Private key in binary type.
-ByteData? get privateKey => _privateKey;
-Indicates type of certificate.
-PKDResourceType get resourceType => _resourceType;
-Provided to a user for passing PKDCertificates -to the native part of DocumentReader.
-typedef PKDCertificateRequest = Future<void> Function(
- List<PKDCertificate>? certificates,
-);
-Will be returned if getByValue if a non-existent was passed.
- - -PKDResourceType(-1)
- PKDResourceType(0)
- PKDResourceType(1)
- PKDResourceType(2)
- PKDResourceType(3)
- PKDResourceType(4)
- PKDResourceType(5)
- PKDResourceType(6)
- PKDResourceType(7)
- [UNKNOWN, CERTIFICATE_PA, CERTIFICATE_TA, LDIF, CRL, ML, DEFL, DEVL, BL]
- const PKDResourceType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Callback for receiving RFID request data
-typedef PaCertificateCompletion = void Function(
- Uint8List serialNumber,
- PAResourcesIssuer? issuer,
- PKDCertificateRequest request,
-);
-Structure is used for storing element bounds detection result._
-Document rotation angle.
-double get angle => _angle;
-Document center coordinates.
-Coordinate? get center => _center;
-Document format.
-DocFormat get docFormat => _docFormat;
-Resolution in dots per inch.
-int get dpi => _dpi;
-Allows you to deserialize object.
-static Position? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Position();
-
- result._docFormat = DocFormat.getByValue(jsonObject["docFormat"])!;
- result._width = jsonObject["width"];
- result._height = jsonObject["height"];
- result._dpi = jsonObject["dpi"];
- result._pageIndex = jsonObject["pageIndex"];
- result._inverse = jsonObject["inverse"];
- result._perspectiveTr = jsonObject["perspectiveTr"];
- result._objArea = jsonObject["objArea"];
- result._objIntAngleDev = jsonObject["objIntAngleDev"];
- result._resultStatus = CheckResult.getByValue(jsonObject["resultStatus"])!;
- result._angle = _toDouble(jsonObject["angle"])!;
- result._center = Coordinate.fromJson(jsonObject["center"]);
- result._leftTop = Coordinate.fromJson(jsonObject["leftTop"]);
- result._leftBottom = Coordinate.fromJson(jsonObject["leftBottom"]);
- result._rightTop = Coordinate.fromJson(jsonObject["rightTop"]);
- result._rightBottom = Coordinate.fromJson(jsonObject["rightBottom"]);
-
- return result;
-}
-Document height.
-int get height => _height;
-Internal use parameter.
-int get inverse => _inverse;
-Document left bottom corner coordinates.
-Coordinate? get leftBottom => _leftBottom;
-Document left top corner coordinates.
-Coordinate? get leftTop => _leftTop;
-Internal use parameter.
-int get objArea => _objArea;
-Internal use parameter.
-int get objIntAngleDev => _objIntAngleDev;
-Index of the document page, whence the result is received.
-int get pageIndex => _pageIndex;
-Internal use parameter.
-int get perspectiveTr => _perspectiveTr;
-Internal use parameter.
-CheckResult get resultStatus => _resultStatus;
-Document right bottom corner coordinates.
-Coordinate? get rightBottom => _rightBottom;
-Document right top corner coordinates.
-Coordinate? get rightTop => _rightTop;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "docFormat": docFormat.value,
- "resultStatus": resultStatus.value,
- "width": width,
- "height": height,
- "angle": angle,
- "dpi": dpi,
- "inverse": inverse,
- "perspectiveTr": perspectiveTr,
- "objArea": objArea,
- "objIntAngleDev": objIntAngleDev,
- "pageIndex": pageIndex,
- "center": center?.toJson(),
- "leftTop": leftTop?.toJson(),
- "leftBottom": leftBottom?.toJson(),
- "rightTop": rightTop?.toJson(),
- "rightBottom": rightBottom?.toJson(),
- }.clearNulls();
-Document width.
-int get width => _width;
-Class contains info about database preparation progress.
-int get downloadedBytes => _downloadedBytes;
-@visibleForTesting
-static PrepareProgress? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return PrepareProgress(
- jsonObject["downloadedBytes"],
- jsonObject["totalBytes"],
- jsonObject["progress"],
- );
-}
-int get progress => _progress;
-int get totalBytes => _totalBytes;
-Params that influence the scanning process.
-true if you know for sure that the image you
-provide contains already cropped document by its edges. This was designed
-to process on the server side images captured and cropped on mobile.
- true, in case required fields are not read, their values
-will be empty.
- true, cropped images will be saved to the application's directory.
- true, images will be saved to the application's directory.
- true, text logs will be saved to the application's directory.
- true, RFID sessions will be saved to the application's directory.
- true, personal information will be removed from logs.
- true, document focus check will be omitted.
- 0 to 1,
-where 1 is when document should fully cover the image.
- true, allows to process up to two pages of the document
-(so-called "a double-page spread") for one-shot if they are presented
-on the frame (image).
- true to make sure that in series processing
-MRZ is located fully inside the result document image, if present
-on the document. Enabling this option may add extra processing time,
-by disabling optimizations, but allows more stability in output image quality.
- 0 is set.
- true, the DocumentReader logs will be shown in the console.
- true, allows you to manually set the document's bounds
-after it is detected.
- US or LR or MM, the
-MeasureSystem.IMPERIAL system of measurement, otherwise, the MeasureSystem.METRIC.
- true, processing of more than one page of the document
-(if they exist) will be triggered, otherwise, only one page will be processed.
- false, the Barcode code parsing will be skipped
-and the raw information from the code will be returned instead.
- 90 degrees.
- true, an image with cropped barcode will be returned.
- true, an original (uncropped) image will be received,
- which is sent for recognition.
- true, the rawResults property of the Results
-will contain the encrypted containers of scanning results
-that may be used for later reprocessing.
- 0 means infinity.
- 0 means infinity.
- 0 means infinity.
- true when torch is connected and enabled by user.
- This option can be set to true if you know for sure that the image you
-provide contains already cropped document by its edges. This was designed
-to process on the server side images captured and cropped on mobile.
bool? get alreadyCropped => _alreadyCropped;
-set alreadyCropped(bool? val) {
- _alreadyCropped = val;
- _set({"alreadyCropped": val});
-}
-AuthenticityParams get authenticityParams => _authenticityParams;
-set authenticityParams(AuthenticityParams val) {
- (_authenticityParams = val)._apply(this);
-}
-Set up the backend processing service parameters.
-BackendProcessingConfig? get backendProcessingConfig =>
- _backendProcessingConfig;
-set backendProcessingConfig(BackendProcessingConfig? val) {
- _backendProcessingConfig = val;
- _set({"backendProcessingConfig": val?.toJson()});
-}
-There are documents that contain barcodes which data can be parsed only -if document type verification is performed. The following property allows -setting the barcode parser type which should be used during recognition. -It allows parsing barcode data without performing document type verification.
-int? get barcodeParserType => _barcodeParserType;
-set barcodeParserType(int? val) {
- _barcodeParserType = val;
- _set({"barcodeParserType": val});
-}
-Set types of barcodes that you wish to recognize. -All barcodes will be recognized if it's empty.
-List<BarcodeType>? get barcodeTypes => _barcodeTypes;
-set barcodeTypes(List<BarcodeType>? val) {
- _barcodeTypes = val;
- _set({"barcodeTypes": val?.map((e) => e.value).toList()});
-}
-Documents processing scenario for the Capture button.
-Scenario? get captureButtonScenario => _captureButtonScenario;
-set captureButtonScenario(Scenario? val) {
- _captureButtonScenario = val;
- _set({"captureButtonScenario": val?.value});
-}
-@deprecated
-bool? get checkHologram => _checkHologram;
-@deprecated
-set checkHologram(bool? val) {
- _checkHologram = val;
- _set({"checkHologram": val});
-}
-If set to true, in case required fields are not read, their values
-will be empty.
bool? get checkRequiredTextFields => _checkRequiredTextFields;
-set checkRequiredTextFields(bool? val) {
- _checkRequiredTextFields = val;
- _set({"checkRequiredTextFields": val});
-}
-This option allows output text case transformation. -No changes applied by default to original values.
-int? get convertCase => _convertCase;
-set convertCase(int? val) {
- _convertCase = val;
- _set({"convertCase": val});
-}
-Takes JSON with parameters that are not presented in the DocumentReader.
-Map<String, dynamic>? get customParams => _customParams;
-set customParams(Map<String, dynamic>? val) {
- _customParams = val;
- _set({"customParams": val});
-}
-Change the format string of displayed dates in the results.
-Mask examples: dd/mm/yyyy, mm/dd/yyyy, dd-mm-yyyy, mm-dd-yyyy, dd/mm/yy.
-Set to null to revert default value.
Default: depends on the device's locale.
-String? get dateFormat => _dateFormat;
-set dateFormat(String? val) {
- _dateFormat = val;
- _set({"dateFormat": val});
-}
-If set to true, cropped images will be saved to the application's directory.
bool? get debugSaveCroppedImages => _debugSaveCroppedImages;
-set debugSaveCroppedImages(bool? val) {
- _debugSaveCroppedImages = val;
- _set({"debugSaveCroppedImages": val});
-}
-If set to true, images will be saved to the application's directory.
bool? get debugSaveImages => _debugSaveImages;
-set debugSaveImages(bool? val) {
- _debugSaveImages = val;
- _set({"debugSaveImages": val});
-}
-If set to true, text logs will be saved to the application's directory.
bool? get debugSaveLogs => _debugSaveLogs;
-set debugSaveLogs(bool? val) {
- _debugSaveLogs = val;
- _set({"debugSaveLogs": val});
-}
-If set to true, RFID sessions will be saved to the application's directory.
bool? get debugSaveRFIDSession => _debugSaveRFIDSession;
-set debugSaveRFIDSession(bool? val) {
- _debugSaveRFIDSession = val;
- _set({"debugSaveRFIDSession": val});
-}
-If set to true, personal information will be removed from logs.
bool? get depersonalizeLog => _depersonalizeLog;
-set depersonalizeLog(bool? val) {
- _depersonalizeLog = val;
- _set({"depersonalizeLog": val});
-}
-If set to true, document focus check will be omitted.
bool? get disableFocusingCheck => _disableFocusingCheck;
-set disableFocusingCheck(bool? val) {
- _disableFocusingCheck = val;
- _set({"disableFocusingCheck": val});
-}
-When enabled, OCR of perforated fields in the document template -will not be performed.
-bool? get disablePerforationOCR => _disablePerforationOCR;
-set disablePerforationOCR(bool? val) {
- _disablePerforationOCR = val;
- _set({"disablePerforationOCR": val});
-}
-Specifies minimal area of the image that document should cover to be treated
-as candidate when locating. Value should be in range from 0 to 1,
-where 1 is when document should fully cover the image.
double? get documentAreaMin => _documentAreaMin;
-set documentAreaMin(double? val) {
- _documentAreaMin = val;
- _set({"documentAreaMin": val});
-}
-Array of specific eligible document types to recognize from. You may, -for example, specify only passports to be recognized by setting this property.
-List<DocType>? get documentGroupFilter => _documentGroupFilter;
-set documentGroupFilter(List<DocType>? val) {
- _documentGroupFilter = val;
- _set({"documentGroupFilter": val?.map((e) => e.value).toList()});
-}
-Takes the list of the document IDs to process. -All documents will be processed if it's empty.
-List<int>? get documentIDList => _documentIDList;
-set documentIDList(List<int>? val) {
- _documentIDList = val;
- _set({"documentIDList": val});
-}
-If set to true, allows to process up to two pages of the document
-(so-called "a double-page spread") for one-shot if they are presented
-on the frame (image).
bool? get doublePageSpread => _doublePageSpread;
-set doublePageSpread(bool? val) {
- _doublePageSpread = val;
- _set({"doublePageSpread": val});
-}
-Custom Face API integration params.
-FaceApiParams? get faceApiParams => _faceApiParams;
-set faceApiParams(FaceApiParams? val) {
- _faceApiParams = val;
- _set({"faceApiParams": val?.toJson()});
-}
-If you recognize the MRZ of documents, all fields will be extracted. -If you recognize the Visual zone of documents, you can set the list -of field types that you wish to extract, other fields will be skipped -during processing. All fields will be extracted if it is empty.
-List<FieldType>? get fieldTypesFilter => _fieldTypesFilter;
-set fieldTypesFilter(List<FieldType>? val) {
- _fieldTypesFilter = val;
- _set({"fieldTypesFilter": val?.map((e) => e.value).toList()});
-}
-Force use of specified document format when locating and recognizing -document to reduce the number of candidates.
-DocFormat? get forceDocFormat => _forceDocFormat;
-set forceDocFormat(DocFormat? val) {
- _forceDocFormat = val;
- _set({"forceDocFormat": val?.value});
-}
-Force use of specific template ID and skip document type identification step.
-int? get forceDocID => _forceDocID;
-set forceDocID(int? val) {
- _forceDocID = val;
- _set({"forceDocID": val});
-}
-This option can be set to true to make sure that in series processing
-MRZ is located fully inside the result document image, if present
-on the document. Enabling this option may add extra processing time,
-by disabling optimizations, but allows more stability in output image quality.
bool? get forceReadMrzBeforeLocate => _forceReadMrzBeforeLocate;
-set forceReadMrzBeforeLocate(bool? val) {
- _forceReadMrzBeforeLocate = val;
- _set({"forceReadMrzBeforeLocate": val});
-}
-Allows you to deserialize object.
-static ProcessParams fromJson(jsonObject) {
- var result = ProcessParams();
- result.testSetters = {};
-
- result.multipageProcessing = jsonObject["multipageProcessing"];
- result.logs = jsonObject["logs"];
- result.debugSaveImages = jsonObject["debugSaveImages"];
- result.debugSaveLogs = jsonObject["debugSaveLogs"];
- result.returnUncroppedImage = jsonObject["returnUncroppedImage"];
- result.uvTorchEnabled = jsonObject["uvTorchEnabled"];
- result.debugSaveCroppedImages = jsonObject["debugSaveCroppedImages"];
- result.disableFocusingCheck = jsonObject["disableFocusingCheck"];
- result.debugSaveRFIDSession = jsonObject["debugSaveRFIDSession"];
- result.doublePageSpread = jsonObject["doublePageSpread"];
- result.manualCrop = jsonObject["manualCrop"];
- result.integralImage = jsonObject["integralImage"];
- result.returnCroppedBarcode = jsonObject["returnCroppedBarcode"];
- result.checkRequiredTextFields = jsonObject["checkRequiredTextFields"];
- result.depersonalizeLog = jsonObject["depersonalizeLog"];
- result.generateDoublePageSpreadImage =
- jsonObject["generateDoublePageSpreadImage"];
- result.alreadyCropped = jsonObject["alreadyCropped"];
- result.matchTextFieldMask = jsonObject["matchTextFieldMask"];
- result.updateOCRValidityByGlare = jsonObject["updateOCRValidityByGlare"];
- result.noGraphics = jsonObject["noGraphics"];
- result.multiDocOnImage = jsonObject["multiDocOnImage"];
- result.forceReadMrzBeforeLocate = jsonObject["forceReadMrzBeforeLocate"];
- result.parseBarcodes = jsonObject["parseBarcodes"];
- result.shouldReturnPackageForReprocess =
- jsonObject["shouldReturnPackageForReprocess"];
- result.disablePerforationOCR = jsonObject["disablePerforationOCR"];
- result.respectImageQuality = jsonObject["respectImageQuality"];
- result.splitNames = jsonObject["splitNames"];
- result.useFaceApi = jsonObject["useFaceApi"];
- result.useAuthenticityCheck = jsonObject["useAuthenticityCheck"];
- // ignore: deprecated_member_use_from_same_package
- result.checkHologram = jsonObject["checkHologram"];
-
- result.measureSystem =
- MeasureSystem.getByValue(jsonObject["measureSystem"]);
- result.barcodeParserType = jsonObject["barcodeParserType"];
- result.perspectiveAngle = jsonObject["perspectiveAngle"];
- result.minDPI = jsonObject["minDPI"];
- result.imageDpiOutMax = jsonObject["imageDpiOutMax"];
- result.forceDocID = jsonObject["forceDocID"];
- result.forceDocFormat = DocFormat.getByValue(jsonObject["forceDocFormat"]);
- result.shiftExpiryDate = jsonObject["shiftExpiryDate"];
- result.minimalHolderAge = jsonObject["minimalHolderAge"];
- result.imageOutputMaxHeight = jsonObject["imageOutputMaxHeight"];
- result.imageOutputMaxWidth = jsonObject["imageOutputMaxWidth"];
- result.processAuth = jsonObject["processAuth"];
- result.convertCase = jsonObject["convertCase"];
-
- result.dateFormat = jsonObject["dateFormat"];
- result.scenario = Scenario.getByValue(jsonObject["scenario"]);
- result.captureButtonScenario =
- Scenario.getByValue(jsonObject["captureButtonScenario"]);
- result.sessionLogFolder = jsonObject["sessionLogFolder"];
-
- result.timeout = _toDouble(jsonObject["timeout"]);
- result.timeoutFromFirstDetect =
- _toDouble(jsonObject["timeoutFromFirstDetect"]);
- result.timeoutFromFirstDocType =
- _toDouble(jsonObject["timeoutFromFirstDocType"]);
- result.documentAreaMin = _toDouble(jsonObject["documentAreaMin"]);
-
- result.documentIDList = jsonObject["documentIDList"] == null
- ? null
- : List<int>.from(jsonObject["documentIDList"]);
- result.barcodeTypes = BarcodeType.fromIntList(jsonObject["barcodeTypes"]);
-
- result.fieldTypesFilter =
- FieldType.fromIntList(jsonObject["fieldTypesFilter"]);
- result.resultTypeOutput =
- ResultType.fromIntList(jsonObject["resultTypeOutput"]);
- result.mrzFormatsFilter =
- MRZFormat.fromStringList(jsonObject["mrzFormatsFilter"]);
- result.documentGroupFilter =
- DocType.fromIntList(jsonObject["documentGroupFilter"]);
- result.lcidIgnoreFilter = LCID.fromIntList(jsonObject["lcidIgnoreFilter"]);
- result.lcidFilter = LCID.fromIntList(jsonObject["lcidFilter"]);
-
- result.imageQA = ImageQA.fromJson(jsonObject["imageQA"]);
- result.rfidParams = RFIDParams.fromJson(jsonObject["rfidParams"]);
- result.faceApiParams = FaceApiParams.fromJson(jsonObject["faceApiParams"]);
- result.backendProcessingConfig =
- BackendProcessingConfig.fromJson(jsonObject["backendProcessingConfig"]);
- result.authenticityParams =
- AuthenticityParams.fromJson(jsonObject["authenticityParams"]);
-
- result.customParams = jsonObject["customParams"];
-
- return result;
-}
-When enabled together with doublePageSpread and there is a passport -with two pages spread in the image, pages will be cropped, straightened -and aligned together, as if the document was captured on a flatbed scanner.
-bool? get generateDoublePageSpreadImage => _generateDoublePageSpreadImage;
-set generateDoublePageSpreadImage(bool? val) {
- _generateDoublePageSpreadImage = val;
- _set({"generateDoublePageSpreadImage": val});
-}
-This option controls maximum resolution in dpi of output images.
-Resolution will remain original in case 0 is set.
int? get imageDpiOutMax => _imageDpiOutMax;
-set imageDpiOutMax(int? val) {
- _imageDpiOutMax = val;
- _set({"imageDpiOutMax": val});
-}
-Maximum height of output images. In pixels.
-int? get imageOutputMaxHeight => _imageOutputMaxHeight;
-set imageOutputMaxHeight(int? val) {
- _imageOutputMaxHeight = val;
- _set({"imageOutputMaxHeight": val});
-}
-Maximum width of output images. In pixels.
-int? get imageOutputMaxWidth => _imageOutputMaxWidth;
-set imageOutputMaxWidth(int? val) {
- _imageOutputMaxWidth = val;
- _set({"imageOutputMaxWidth": val});
-}
-Controls properties of ImageQA checks.
-ImageQA get imageQA => _imageQA;
-set imageQA(ImageQA val) {
- (_imageQA = val)._apply(this);
-}
-Allows to build an integral image, taking into account the quality of -fixation of each of the individual images.
-bool? get integralImage => _integralImage;
-set integralImage(bool? val) {
- _integralImage = val;
- _set({"integralImage": val});
-}
-The whitelist of LCID types to use during the recognition.
-List<LCID>? get lcidFilter => _lcidFilter;
-set lcidFilter(List<LCID>? val) {
- _lcidFilter = val;
- _set({"lcidFilter": val?.map((e) => e.value).toList()});
-}
-The list of LCID types to ignore during the recognition. -If empty, values with all LCID types will be extracted. -Narrowing down the list can reduce processing time.
-List<LCID>? get lcidIgnoreFilter => _lcidIgnoreFilter;
-set lcidIgnoreFilter(List<LCID>? val) {
- _lcidIgnoreFilter = val;
- _set({"lcidIgnoreFilter": val?.map((e) => e.value).toList()});
-}
-If set to true, the DocumentReader logs will be shown in the console.
bool? get logs => _logs;
-set logs(bool? val) {
- _logs = val;
- _set({"logs": val});
-}
-If set to true, allows you to manually set the document's bounds
-after it is detected.
bool? get manualCrop => _manualCrop;
-set manualCrop(bool? val) {
- _manualCrop = val;
- _set({"manualCrop": val});
-}
-When disabled, text field OCR will be done as is and then the recognized -value will be matched to the field mask for validity. If enabled, we -are trying to read a field value with maximum efforts to match the mask -and provide a correctly formatted value, making assumptions based on the -provided field mask in the template.
-bool? get matchTextFieldMask => _matchTextFieldMask;
-set matchTextFieldMask(bool? val) {
- _matchTextFieldMask = val;
- _set({"matchTextFieldMask": val});
-}
-Measure system of fields' values that are presented in results.
-Default: If the country code is US or LR or MM, the
-MeasureSystem.IMPERIAL system of measurement, otherwise, the MeasureSystem.METRIC.
MeasureSystem? get measureSystem => _measureSystem;
-set measureSystem(MeasureSystem? val) {
- _measureSystem = val;
- _set({"measureSystem": val?.value});
-}
-Allows you to set the minimum acceptable DPI value of the camera frame -that is passed for recognition. Camera frames the DPI of which are less -than you set won't be passed for recognition.
-int? get minDPI => _minDPI;
-set minDPI(int? val) {
- _minDPI = val;
- _set({"minDPI": val});
-}
-This options allows specifying the minimal age in years of the document -holder for the document to be considered valid.
-int? get minimalHolderAge => _minimalHolderAge;
-set minimalHolderAge(int? val) {
- _minimalHolderAge = val;
- _set({"minimalHolderAge": val});
-}
-This option allows limiting MRZ formats to be recognized by specifying -them in array.
-List<MRZFormat>? get mrzFormatsFilter => _mrzFormatsFilter;
-set mrzFormatsFilter(List<MRZFormat>? val) {
- _mrzFormatsFilter = val;
- _set({"mrzFormatsFilter": val?.map((e) => e.value).toList()});
-}
-This option allows locating and cropping multiple documents -from one image if enabled.
-bool? get multiDocOnImage => _multiDocOnImage;
-set multiDocOnImage(bool? val) {
- _multiDocOnImage = val;
- _set({"multiDocOnImage": val});
-}
-If set to true, processing of more than one page of the document
-(if they exist) will be triggered, otherwise, only one page will be processed.
bool? get multipageProcessing => _multipageProcessing;
-set multipageProcessing(bool? val) {
- _multipageProcessing = val;
- _set({"multipageProcessing": val});
-}
-When enabled no graphic fields will be cropped from document image.
-bool? get noGraphics => _noGraphics;
-set noGraphics(bool? val) {
- _noGraphics = val;
- _set({"noGraphics": val});
-}
-When set to false, the Barcode code parsing will be skipped
-and the raw information from the code will be returned instead.
bool? get parseBarcodes => _parseBarcodes;
-set parseBarcodes(bool? val) {
- _parseBarcodes = val;
- _set({"parseBarcodes": val});
-}
-Allows you to set the maximum value of the deviation of the corners
-of the document from the value of 90 degrees.
int? get perspectiveAngle => _perspectiveAngle;
-set perspectiveAngle(int? val) {
- _perspectiveAngle = val;
- _set({"perspectiveAngle": val});
-}
-Accepts sum of Authenticity values.
-int? get processAuth => _processAuth;
-set processAuth(int? val) {
- _processAuth = val;
- _set({"processAuth": val});
-}
-When enabled, image quality checks status affects document optical -and overall status.
-bool? get respectImageQuality => _respectImageQuality;
-set respectImageQuality(bool? val) {
- _respectImageQuality = val;
- _set({"respectImageQuality": val});
-}
-Types of results to return in response.
-List<ResultType>? get resultTypeOutput => _resultTypeOutput;
-set resultTypeOutput(List<ResultType>? val) {
- _resultTypeOutput = val;
- _set({"resultTypeOutput": val?.map((e) => e.value).toList()});
-}
-If set to true, an image with cropped barcode will be returned.
bool? get returnCroppedBarcode => _returnCroppedBarcode;
-set returnCroppedBarcode(bool? val) {
- _returnCroppedBarcode = val;
- _set({"returnCroppedBarcode": val});
-}
-If set to true, an original (uncropped) image will be received,
- which is sent for recognition.
bool? get returnUncroppedImage => _returnUncroppedImage;
-set returnUncroppedImage(bool? val) {
- _returnUncroppedImage = val;
- _set({"returnUncroppedImage": val});
-}
-Custom RFID params.
-RFIDParams? get rfidParams => _rfidParams;
-set rfidParams(RFIDParams? val) {
- _rfidParams = val;
- _set({"rfidParams": val?.toJson()});
-}
-Documents processing scenario.
-Scenario? get scenario => _scenario;
-set scenario(Scenario? val) {
- _scenario = val;
- _set({"scenario": val?.value});
-}
-The path to the folder of the current session. Before using this, save logs. -Each new session provides a different path.
-String? get sessionLogFolder => _sessionLogFolder;
-set sessionLogFolder(String? val) {
- _sessionLogFolder = val;
- _set({"sessionLogFolder": val});
-}
-This option allows shifting the date of expiry into the future or past -for number of months specified. This is useful, for example, in some cases -when document might be still valid for some period after original -expiration date to prevent negative validity status for such documents. -Or by shifting the date to the past will set negative validity -for the documents that is about to expire in a specified number of months.
-int? get shiftExpiryDate => _shiftExpiryDate;
-set shiftExpiryDate(int? val) {
- _shiftExpiryDate = val;
- _set({"shiftExpiryDate": val});
-}
-When set to true, the rawResults property of the Results
-will contain the encrypted containers of scanning results
-that may be used for later reprocessing.
bool? get shouldReturnPackageForReprocess => _shouldReturnPackageForReprocess;
-set shouldReturnPackageForReprocess(bool? val) {
- _shouldReturnPackageForReprocess = val;
- _set({"shouldReturnPackageForReprocess": val});
-}
-When enabled, the Surname and GivenNames field (TextField) -will be divided into fields with fieldTypes FieldType.FIRST_NAME, -FieldType.SECOND_NAME, FieldType.THIRD_NAME, FieldType.LAST_NAME.
-bool? get splitNames => _splitNames;
-set splitNames(bool? val) {
- _splitNames = val;
- _set({"splitNames": val});
-}
-Allows you to set the time limit for document recognition (in seconds),
-beyond which the recognition does not continue regardless of its result.
-The countdown starts from the moment the scenario starts.
-Setting value to 0 means infinity.
double? get timeout => _timeout;
-set timeout(double? val) {
- _timeout = val;
- _set({"timeout": val});
-}
-Allows you to set the time limit for document recognition (in seconds),
-beyond which the recognition does not continue regardless of its result.
-The countdown starts from the moment the document is detected.
-Setting value to 0 means infinity.
double? get timeoutFromFirstDetect => _timeoutFromFirstDetect;
-set timeoutFromFirstDetect(double? val) {
- _timeoutFromFirstDetect = val;
- _set({"timeoutFromFirstDetect": val});
-}
-Allows you to set the time limit for document recognition (in seconds),
-beyond which the recognition does not continue regardless of its result.
-The countdown starts from the moment the document type is recognized.
-Setting value to 0 means infinity.
double? get timeoutFromFirstDocType => _timeoutFromFirstDocType;
-set timeoutFromFirstDocType(double? val) {
- _timeoutFromFirstDocType = val;
- _set({"timeoutFromFirstDocType": val});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "multipageProcessing": multipageProcessing,
- "debugSaveImages": debugSaveImages,
- "debugSaveLogs": debugSaveLogs,
- "returnUncroppedImage": returnUncroppedImage,
- "uvTorchEnabled": uvTorchEnabled,
- "debugSaveCroppedImages": debugSaveCroppedImages,
- "disableFocusingCheck": disableFocusingCheck,
- "debugSaveRFIDSession": debugSaveRFIDSession,
- "doublePageSpread": doublePageSpread,
- "manualCrop": manualCrop,
- "integralImage": integralImage,
- "returnCroppedBarcode": returnCroppedBarcode,
- "checkRequiredTextFields": checkRequiredTextFields,
- "depersonalizeLog": depersonalizeLog,
- "generateDoublePageSpreadImage": generateDoublePageSpreadImage,
- "alreadyCropped": alreadyCropped,
- "matchTextFieldMask": matchTextFieldMask,
- "updateOCRValidityByGlare": updateOCRValidityByGlare,
- "noGraphics": noGraphics,
- "multiDocOnImage": multiDocOnImage,
- "forceReadMrzBeforeLocate": forceReadMrzBeforeLocate,
- "parseBarcodes": parseBarcodes,
- "shouldReturnPackageForReprocess": shouldReturnPackageForReprocess,
- "disablePerforationOCR": disablePerforationOCR,
- "respectImageQuality": respectImageQuality,
- "splitNames": splitNames,
- "useFaceApi": useFaceApi,
- "useAuthenticityCheck": useAuthenticityCheck,
- // ignore: deprecated_member_use_from_same_package
- "checkHologram": checkHologram,
- "measureSystem": measureSystem?.value,
- "barcodeParserType": barcodeParserType,
- "perspectiveAngle": perspectiveAngle,
- "minDPI": minDPI,
- "imageDpiOutMax": imageDpiOutMax,
- "forceDocID": forceDocID,
- "forceDocFormat": forceDocFormat?.value,
- "shiftExpiryDate": shiftExpiryDate,
- "minimalHolderAge": minimalHolderAge,
- "imageOutputMaxHeight": imageOutputMaxHeight,
- "imageOutputMaxWidth": imageOutputMaxWidth,
- "processAuth": processAuth,
- "convertCase": convertCase,
- "dateFormat": dateFormat,
- "scenario": scenario?.value,
- "captureButtonScenario": captureButtonScenario?.value,
- "sessionLogFolder": sessionLogFolder,
- "timeout": timeout,
- "timeoutFromFirstDetect": timeoutFromFirstDetect,
- "timeoutFromFirstDocType": timeoutFromFirstDocType,
- "documentAreaMin": documentAreaMin,
- "documentIDList": documentIDList,
- "barcodeTypes": barcodeTypes?.map((e) => e.value).toList(),
- "fieldTypesFilter": fieldTypesFilter?.map((e) => e.value).toList(),
- "resultTypeOutput": resultTypeOutput?.map((e) => e.value).toList(),
- "mrzFormatsFilter": mrzFormatsFilter?.map((e) => e.value).toList(),
- "documentGroupFilter":
- documentGroupFilter?.map((e) => e.value).toList(),
- "lcidIgnoreFilter": lcidIgnoreFilter?.map((e) => e.value).toList(),
- "lcidFilter": lcidFilter?.map((e) => e.value).toList(),
- "imageQA": imageQA.toJson(),
- "rfidParams": rfidParams?.toJson(),
- "faceApiParams": faceApiParams?.toJson(),
- "backendProcessingConfig": backendProcessingConfig?.toJson(),
- "authenticityParams": authenticityParams.toJson(),
- "customParams": customParams,
- }.clearNulls();
-When enabled, fail OCR field validity, if there is a glare over the text -ƒfield on the image.
-bool? get updateOCRValidityByGlare => _updateOCRValidityByGlare;
-set updateOCRValidityByGlare(bool? val) {
- _updateOCRValidityByGlare = val;
- _set({"updateOCRValidityByGlare": val});
-}
-This parameter is used to enable document authenticity check.
-bool? get useAuthenticityCheck => _useAuthenticityCheck;
-set useAuthenticityCheck(bool? val) {
- _useAuthenticityCheck = val;
- _set({"useAuthenticityCheck": val});
-}
-Use this property to set up the Face API integration.
-bool? get useFaceApi => _useFaceApi;
-set useFaceApi(bool? val) {
- _useFaceApi = val;
- _set({"useFaceApi": val});
-}
-Set to true when torch is connected and enabled by user.
Android only.
-bool? get uvTorchEnabled => _uvTorchEnabled;
-set uvTorchEnabled(bool? val) {
- _uvTorchEnabled = val;
- _set({"uvTorchEnabled": val});
-}
-Enumeration contains identifiers that determine the processing finish status.
-Will be returned if getByValue if a non-existent was passed.
- - -ProcessingFinishedStatus(-1)
- Processing is not finished.
- - -ProcessingFinishedStatus(0)
- Processing is finished.
- - -ProcessingFinishedStatus(1)
- Processing is finished by timeout.
- - -ProcessingFinishedStatus(2)
- [UNKNOWN, NOT_READY, READY, TIMEOUT]
- const ProcessingFinishedStatus
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Type is not defined.
- - -RFIDAccessControlProcedureType(0)
- Basic Access Control (BAC) / Protection (BAP).
- - -RFIDAccessControlProcedureType(1)
- Password Authenticated Connection Establishment.
- - -RFIDAccessControlProcedureType(2)
- Chip Authentication.
- - -RFIDAccessControlProcedureType(3)
- Terminal Authentication.
- - -RFIDAccessControlProcedureType(4)
- Active Authentication.
- - -RFIDAccessControlProcedureType(5)
- Restricted Identification.
- - -RFIDAccessControlProcedureType(6)
- Card info.
- - -RFIDAccessControlProcedureType(10)
- [UNDEFINED, BAC, PACE, CA, TA, AA, RI, CARD_INFO]
- const RFIDAccessControlProcedureType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Not defined.
- - -RFIDAuthenticationProcedureType(0)
- Standard authentication procedure.
- - -RFIDAuthenticationProcedureType(1)
- Advanced authentication procedure.
- - -RFIDAuthenticationProcedureType(2)
- General authentication procedure.
- - -RFIDAuthenticationProcedureType(3)
- [UNDEFINED, STANDARD, ADVANCED, GENERAL]
- const RFIDAuthenticationProcedureType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-RFIDCertificateType(0)
- RFIDCertificateType(1)
- RFIDCertificateType(2)
- RFIDCertificateType(3)
- RFIDCertificateType(4)
- RFIDCertificateType(5)
- RFIDCertificateType(6)
- RFIDCertificateType(7)
- RFIDCertificateType(8)
- RFIDCertificateType(9)
- RFIDCertificateType(10)
- [UNDEFINED, CSCA, CSCA_LINK, DS, MLS, DEV_LS, DEF_LS, BLS, LDS2, BCS, BCSNC]
- const RFIDCertificateType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Callback for receiving answer from processing engine.
-action defines current processing status.
results defines current processing results.
error in case of anything is wrong - brief message for developer, null otherwise.
typedef RFIDCompletion = void Function(
- DocReaderAction action,
- Results? results,
- RFIDException? error,
-);
-A configuration file for the RFID chip processing.
-Regular RFID chip reading.
-completion - block to execute after the chip reading process finishes.
RFIDConfig
-RFID chip reading with no UI.
-User is supposed to implement the UI.
-Since this constructor accepts RFIDCompletion -instead of DocumentReaderCompletion, user will be provided -with more in-depth error information.
-completion - block to execute after the chip reading process finishes.
RFIDConfig.withoutUI(RFIDCompletion completion)
- : _rfidCompletion = completion,
- _disableUI = true;
-Callback for receiving signal when RFID chip is recognized -by a phone and chip reading is started.
-Only used with default constructor. If RFIDConfig.withoutUI was used, -you will receive this update via DocumentReaderCompletion.
-ChipDetectedCompletion? onChipDetected;
-Callback for reveiving notification about RFID reading process.
-RFIDProgressCompletion? onProgress;
-Callback for receiving RFID request data
-PaCertificateCompletion? onRequestPACertificates;
-Callback for receiving RFID request data
-TaCertificateCompletion? onRequestTACertificates;
-Callback for receiving RFID request data
-TaSignatureCompletion? onRequestTASignature;
-Fires when RFID chip reading was interrupted with no severe reasons -(for example connection to the chip was lost) and will be reestablished automatically.
-Only used with default constructor. If RFIDConfig.withoutUI was used, -you will receive this update via DocumentReaderCompletion -and chip reading will not be reestablished.
-RetryReadChipCompletion? onRetryReadChip;
-Enumeration contains a set of constants that define the file type -(or logical belonging of the data object) within the context of the -communication session with electronic document.
-Will be returned if getByValue if a non-existent was passed.
- - -RFIDDataFileType(-1)
- RFIDDataFileType(0)
- RFIDDataFileType(1)
- RFIDDataFileType(2)
- RFIDDataFileType(3)
- RFIDDataFileType(4)
- RFIDDataFileType(5)
- RFIDDataFileType(6)
- RFIDDataFileType(7)
- RFIDDataFileType(8)
- RFIDDataFileType(9)
- RFIDDataFileType(10)
- RFIDDataFileType(11)
- RFIDDataFileType(12)
- RFIDDataFileType(13)
- RFIDDataFileType(14)
- RFIDDataFileType(15)
- RFIDDataFileType(16)
- RFIDDataFileType(17)
- RFIDDataFileType(18)
- RFIDDataFileType(19)
- RFIDDataFileType(20)
- RFIDDataFileType(21)
- RFIDDataFileType(22)
- RFIDDataFileType(23)
- RFIDDataFileType(101)
- RFIDDataFileType(102)
- RFIDDataFileType(103)
- RFIDDataFileType(104)
- RFIDDataFileType(105)
- RFIDDataFileType(106)
- RFIDDataFileType(107)
- RFIDDataFileType(108)
- RFIDDataFileType(109)
- RFIDDataFileType(110)
- RFIDDataFileType(111)
- RFIDDataFileType(112)
- RFIDDataFileType(113)
- RFIDDataFileType(114)
- RFIDDataFileType(115)
- RFIDDataFileType(116)
- RFIDDataFileType(117)
- RFIDDataFileType(118)
- RFIDDataFileType(119)
- RFIDDataFileType(120)
- RFIDDataFileType(121)
- RFIDDataFileType(150)
- RFIDDataFileType(151)
- RFIDDataFileType(152)
- RFIDDataFileType(153)
- RFIDDataFileType(154)
- RFIDDataFileType(155)
- RFIDDataFileType(156)
- RFIDDataFileType(157)
- RFIDDataFileType(158)
- RFIDDataFileType(159)
- RFIDDataFileType(160)
- RFIDDataFileType(161)
- RFIDDataFileType(162)
- RFIDDataFileType(163)
- RFIDDataFileType(164)
- RFIDDataFileType(165)
- RFIDDataFileType(166)
- RFIDDataFileType(167)
- RFIDDataFileType(200)
- RFIDDataFileType(201)
- RFIDDataFileType(202)
- RFIDDataFileType(300)
- RFIDDataFileType(301)
- RFIDDataFileType(302)
- RFIDDataFileType(400)
- RFIDDataFileType(500)
- RFIDDataFileType(501)
- RFIDDataFileType(600)
- RFIDDataFileType(601)
- RFIDDataFileType(602)
- RFIDDataFileType(603)
- RFIDDataFileType(700)
- RFIDDataFileType(701)
- RFIDDataFileType(702)
- RFIDDataFileType(703)
- RFIDDataFileType(800)
- RFIDDataFileType(800 + 32)
- RFIDDataFileType(900)
- RFIDDataFileType(901)
- RFIDDataFileType(1000)
- [UNKNOWN, UNSPECIFIED, PASSPORT_DG1, PASSPORT_DG2, PASSPORT_DG3, PASSPORT_DG4, PASSPORT_DG5, PASSPORT_DG6, PASSPORT_DG7, PASSPORT_DG8, PASSPORT_DG9, PASSPORT_DG10, PASSPORT_DG11, PASSPORT_DG12, PASSPO…
- const RFIDDataFileType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-RFIDErrorCodes(0)
- RFIDErrorCodes(0x00000001)
- RFIDErrorCodes(0x00000002)
- RFIDErrorCodes(0xffffffff)
- RFIDErrorCodes(0x80010001)
- RFIDErrorCodes(0x80010002)
- RFIDErrorCodes(0x80010004)
- RFIDErrorCodes(0x80010005)
- RFIDErrorCodes(0x80010006)
- RFIDErrorCodes(0x80010008)
- RFIDErrorCodes(0x80010009)
- RFIDErrorCodes(0x8001000A)
- RFIDErrorCodes(0x8001000B)
- RFIDErrorCodes(0x8001000C)
- RFIDErrorCodes(0x80020000)
- RFIDErrorCodes(0x80020001)
- RFIDErrorCodes(0x80020002)
- RFIDErrorCodes(0x80020003)
- RFIDErrorCodes(0x80020004)
- RFIDErrorCodes(0x80020005)
- RFIDErrorCodes(0x80020006)
- RFIDErrorCodes(0x80020010)
- RFIDErrorCodes(0x86000000)
- RFIDErrorCodes(0x86000001)
- RFIDErrorCodes(0x86000100)
- RFIDErrorCodes(0x86000101)
- RFIDErrorCodes(0x86000102)
- RFIDErrorCodes(0x86000103)
- RFIDErrorCodes(0x86000200)
- RFIDErrorCodes(0x86000201)
- RFIDErrorCodes(0x86000202)
- RFIDErrorCodes(0x86000203)
- RFIDErrorCodes(0x86000204)
- RFIDErrorCodes(0x86000300)
- RFIDErrorCodes(0x86000301)
- RFIDErrorCodes(0x86000302)
- RFIDErrorCodes(0x86000303)
- RFIDErrorCodes(0x86000304)
- RFIDErrorCodes(0x86000305)
- RFIDErrorCodes(0x86000306)
- RFIDErrorCodes(0x86000307)
- RFIDErrorCodes(0x86000308)
- RFIDErrorCodes(0x86000309)
- RFIDErrorCodes(0x80006A82)
- RFIDErrorCodes(0x80006282)
- RFIDErrorCodes(0x80006B00)
- RFIDErrorCodes(0x80006A80)
- RFIDErrorCodes(0x80006A88)
- RFIDErrorCodes(0x800063C1)
- RFIDErrorCodes(0x800063C0)
- RFIDErrorCodes(0x80006283)
- RFIDErrorCodes(0x80006983)
- RFIDErrorCodes(0x80006984)
- RFIDErrorCodes(0x80006985)
- RFIDErrorCodes(0x801063C0)
- RFIDErrorCodes(0x83000000)
- RFIDErrorCodes(0x83000001)
- RFIDErrorCodes(0x83000002)
- RFIDErrorCodes(0x83000010)
- RFIDErrorCodes(0x83000011)
- RFIDErrorCodes(0x83000012)
- RFIDErrorCodes(0x83000013)
- RFIDErrorCodes(0x83000014)
- RFIDErrorCodes(0x83000015)
- RFIDErrorCodes(0x83000016)
- RFIDErrorCodes(0x83000017)
- RFIDErrorCodes(0x83000018)
- RFIDErrorCodes(0x83000019)
- RFIDErrorCodes(0x8300001A)
- RFIDErrorCodes(0x8300001B)
- RFIDErrorCodes(0x8300001C)
- RFIDErrorCodes(0x83000020)
- RFIDErrorCodes(0x83000021)
- RFIDErrorCodes(0x83000022)
- RFIDErrorCodes(0x83000023)
- RFIDErrorCodes(0x83000024)
- RFIDErrorCodes(0x83000025)
- RFIDErrorCodes(0x83000026)
- RFIDErrorCodes(0x83000027)
- RFIDErrorCodes(0x83000028)
- RFIDErrorCodes(0x83000029)
- RFIDErrorCodes(0x8300002A)
- RFIDErrorCodes(0x83000030)
- RFIDErrorCodes(0x83000031)
- RFIDErrorCodes(0x83000040)
- RFIDErrorCodes(0x83000041)
- RFIDErrorCodes(0x83000042)
- RFIDErrorCodes(0x83000050)
- RFIDErrorCodes(0x83000051)
- RFIDErrorCodes(0x83000052)
- RFIDErrorCodes(0x83000060)
- RFIDErrorCodes(0x83010000)
- RFIDErrorCodes(0x83020000)
- RFIDErrorCodes(0x83030000)
- RFIDErrorCodes(0x83040000)
- RFIDErrorCodes(0x83050000)
- RFIDErrorCodes(0x83060000)
- RFIDErrorCodes(0x83070000)
- RFIDErrorCodes(0x83080000)
- RFIDErrorCodes(0x84000000)
- RFIDErrorCodes(0x84010000)
- RFIDErrorCodes(0x84020000)
- RFIDErrorCodes(0x84030000)
- RFIDErrorCodes(0x84040000)
- RFIDErrorCodes(0x84050000)
- RFIDErrorCodes(0x84060000)
- RFIDErrorCodes(0x84070000)
- RFIDErrorCodes(0x84080000)
- RFIDErrorCodes(0x84090000)
- RFIDErrorCodes(0x840A0000)
- RFIDErrorCodes(0x840B0000)
- RFIDErrorCodes(0x840C0000)
- RFIDErrorCodes(0x840D0000)
- RFIDErrorCodes(0x840E0000)
- RFIDErrorCodes(0x840F0000)
- [UNDEFINED, NO_ERROR, ALREADY_DONE, FAILED, NO_CHIP_DETECTED, NOT_AVAILABLE, INVALID_PARAMETER, NOT_INITIALIZED, NOT_ENOUGH_MEMORY, INVALID_DIRECTORY, UNKNOWN_COMMAND, FILE_IO_ERROR, BUSY, OLD_FIRMWAR…
- const RFIDErrorCodes
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-RFIDErrorCodes get code => _code;
-@visibleForTesting
-static RFIDException? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDException();
-
- result._code = RFIDErrorCodes.getByValue(jsonObject["code"])!;
- result._message = jsonObject["message"] ?? "";
-
- return result;
-}
-String get message => _message;
-Structure containing data of notification about RFID reading process.
-Defines the file type (or logical belonging of the data object) within -the context of the communication session with electronic document.
-RFIDDataFileType get dataFileType => _dataFileType;
-@visibleForTesting
-static RFIDNotification? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDNotification();
-
- result._notificationCode =
- RFIDNotificationCodes.getByValue(jsonObject["notificationCode"])!;
- result._dataFileType =
- RFIDDataFileType.getByValue(jsonObject["dataFileType"])!;
- result._progress = jsonObject["progress"];
-
- return result;
-}
-RFID notification code.
-RFIDNotificationCodes get notificationCode => _notificationCode;
-RFID progress.
-int get progress => _progress;
-Enumeration contains a set of notification returned -to the user application by calling the callback-function.
-Will be returned by getByValue if a non-existent value was passed.
- - -RFIDNotificationCodes(-1)
- The notification indicates an error.
- - -RFIDNotificationCodes(65536)
- Event of appearance of RFID-chip in the scope of the reader antenna -or its moving away from the scope of the reader.
- - -RFIDNotificationCodes(65537)
- Event of the beginning/end of data reading from the RFID-chip via ISO/IEC -14443-4 proto-col When working in the batch mode.
- - -RFIDNotificationCodes(65539)
- Event of the beginning/end of data reading from the RFID-chip via ISO/IEC -14443-3 proto-col.
- - -RFIDNotificationCodes(65546)
- Indication of the progress of execution of data reading operation.
- - -RFIDNotificationCodes(65547)
- Indication of the next step of terminal authentication in -Online-authentication mode.
- - -RFIDNotificationCodes(65550)
- Event of detection of the need to organize a secure communication channel.
- - -RFIDNotificationCodes(65551)
- Event informing the user application on detection of data incompliance -processed with the regulations of normative documents, errors when -executing the current operation.
- - -RFIDNotificationCodes(69632)
- Request of the user-defined DS-certificate priot to the procedure of digital -signature verifi-cation of EF.SOD document security object in the batch mode.
- - -RFIDNotificationCodes(77824)
- Event of the result of the opening of a secure communication channel.
- - -RFIDNotificationCodes(81935)
- Event of unplugging of the RFID-chip reader from the PC.
- - -RFIDNotificationCodes(131072)
- Event of the beginning of reorganization of the list of RFID-readers -connected to the PC, working under PC/SC-driver control.
- - -RFIDNotificationCodes(131073)
- Transfer of the total amount of information received from the RFID-chip -to the user appli-cation during execution of data reading operation.
- - -RFIDNotificationCodes(131074)
- Transfer of the total time of execution of data reading operation -to the user application.
- - -RFIDNotificationCodes(131075)
- Transfer of the total amount of information and service groups data -received from the RF-ID-chip to the user application during execution -of data reading operation.
- - -RFIDNotificationCodes(131076)
- Transfer of the total amount of information transmitted to the RFID-chip -to the user appli-cation during execution of data reading operation.
- - -RFIDNotificationCodes(131077)
- Transfer of the average data reading rate to the user application.
- - -RFIDNotificationCodes(131078)
- Transfer of the total time of execution of data reading procedure -to the user application.
- - -RFIDNotificationCodes(131079)
- Event of the beginning of reorganization of the list of RFID-readers -connected to the PC, working under PC/SC-driver control.
- - -RFIDNotificationCodes(131080)
- Event of detection of extended length reading commands support -by the RFID-chip.
- - -RFIDNotificationCodes(131088)
- Event of the start/end of the certificate chain formation for the -document security object digital signature verification -as a part of passive authentication procedure.
- - -RFIDNotificationCodes(131089)
- Event that indicates a type of the current analyzed element of the -certificate chain being composed.
-All subsequent notifications prior to the next PA_CERTIFICATE_CHAIN_ITEM -or PA_CERTIFICATE_CHAIN will correspond to this element.
- - -RFIDNotificationCodes(131090)
- A request from the user application of some data or actions in a certain -step of the scenario.
- - -RFIDNotificationCodes(131104)
- Event of the beginning/end of file reading.
- - -RFIDNotificationCodes(196608)
- Event of detection of file absence.
- - -RFIDNotificationCodes(262144)
- Event of reaching the file end when performing its reading.
- - -RFIDNotificationCodes(327680)
- Event of detection of absence of the file access rights.
- - -RFIDNotificationCodes(393216)
- Event of the application selection operation.
- - -RFIDNotificationCodes(458752)
- Event of the beginning of the authentication or secure data access procedure.
- - -RFIDNotificationCodes(524288)
- Event of the end of the authentication or secure data access procedure.
- - -RFIDNotificationCodes(589824)
- Event of the data security object verification as part of PA.
- - -RFIDNotificationCodes(655360)
- Event of the file data integrity checking as part of PA.
- - -RFIDNotificationCodes(720896)
- Event of the procedure of file contents updating.
- - -RFIDNotificationCodes(786432)
- Event of the auxiliary data verification.
- - -RFIDNotificationCodes(851968)
- Event of the receiving of the sector identifier data during RI.
- - -RFIDNotificationCodes(917504)
- Event of the detection of real biometric data absence in DG3 or DG4 -and random filling data usage.
- - -RFIDNotificationCodes(983040)
- [UNKNOWN, ERROR, DOCUMENT_READY, READ_PROTOCOL4, READ_PROTOCOL3, PROGRESS, TA_STEP, SM_REQUIRED, ISO_ERROR, PA_REQUEST, SM_ESTABLISHED, PCSC_READER_DISCONNECTED, PCSC_READER_LIST_CHANGED, PCSC_BYTES_R…
- const RFIDNotificationCodes
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Structure containing rfid origin values.
-int get dg => _dg;
-int get dgTag => _dgTag;
-int get entryView => _entryView;
-Allows you to deserialize object.
-static RFIDOrigin? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDOrigin();
-
- result._dg = jsonObject["dg"];
- result._dgTag = jsonObject["dgTag"];
- result._entryView = jsonObject["entryView"];
- result._tagEntry = jsonObject["tagEntry"];
-
- return result;
-}
-int get tagEntry => _tagEntry;
-Allows you to deserialize object.
-static RFIDParams? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- return RFIDParams(
- paIgnoreNotificationCodes: jsonObject["paIgnoreNotificationCodes"] == null
- ? null
- : List<int>.from(jsonObject["paIgnoreNotificationCodes"]),
- );
-}
-A list of notification codes that should be ignored during -passive authentication (PA).
-List<int>? get paIgnoreNotificationCodes => _paIgnoreNotificationCodes;
-Unknown type.
- - -RFIDPasswordType(0)
- MRZ.
- - -RFIDPasswordType(1)
- CAN.
- - -RFIDPasswordType(2)
- PIN.
- - -RFIDPasswordType(3)
- PUK.
- - -RFIDPasswordType(4)
- eSign-PIN.
- - -RFIDPasswordType(5)
- Scanning Area Identifier (for eDL application).
- - -RFIDPasswordType(6)
- [UNDEFINED, MRZ, CAN, PIN, PUK, PIN_ESIGN, SAI]
- const RFIDPasswordType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Completion for reveiving notification about RFID reading process.
-typedef RFIDProgressCompletion = void Function(RFIDNotification notification);
-Will be returned if getByValue if a non-existent was passed.
- - -RFIDSDKProfilerType(-1)
- Doc 9303, 6th edition, 2006.
- - -RFIDSDKProfilerType(0x00000001)
- LDS and PKI Maintenance, v2.0, May 21, 2014.
- - -RFIDSDKProfilerType(0x00000002)
- [UNKNOWN, DOC_9303_EDITION_2006, DOC_9303_LDS_PKI_MAINTENANCE]
- const RFIDSDKProfilerType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Params that influence the RFID chip processing.
-bool? get applyAmendments => _applyAmendments;
-set applyAmendments(bool? val) {
- _applyAmendments = val;
- _set({"applyAmendments": val});
-}
-RFIDAuthenticationProcedureType? get authProcType => _authProcType;
-set authProcType(RFIDAuthenticationProcedureType? val) {
- _authProcType = val;
- _set({"authProcType": val?.value});
-}
-bool? get authorizedCANAllowed => _authorizedCANAllowed;
-set authorizedCANAllowed(bool? val) {
- _authorizedCANAllowed = val;
- _set({"authorizedCANAllowed": val});
-}
-bool? get authorizedInstallCert => _authorizedInstallCert;
-set authorizedInstallCert(bool? val) {
- _authorizedInstallCert = val;
- _set({"authorizedInstallCert": val});
-}
-bool? get authorizedInstallQCert => _authorizedInstallQCert;
-set authorizedInstallQCert(bool? val) {
- _authorizedInstallQCert = val;
- _set({"authorizedInstallQCert": val});
-}
-bool? get authorizedPINManagement => _authorizedPINManagement;
-set authorizedPINManagement(bool? val) {
- _authorizedPINManagement = val;
- _set({"authorizedPINManagement": val});
-}
-bool? get authorizedPrivilegedTerminal => _authorizedPrivilegedTerminal;
-set authorizedPrivilegedTerminal(bool? val) {
- _authorizedPrivilegedTerminal = val;
- _set({"authorizedPrivilegedTerminal": val});
-}
-bool? get authorizedRestrictedIdentification =>
- _authorizedRestrictedIdentification;
-set authorizedRestrictedIdentification(bool? val) {
- _authorizedRestrictedIdentification = val;
- _set({"authorizedRestrictedIdentification": val});
-}
-bool? get authorizedSTQSignature => _authorizedSTQSignature;
-set authorizedSTQSignature(bool? val) {
- _authorizedSTQSignature = val;
- _set({"authorizedSTQSignature": val});
-}
-bool? get authorizedSTSignature => _authorizedSTSignature;
-set authorizedSTSignature(bool? val) {
- _authorizedSTSignature = val;
- _set({"authorizedSTSignature": val});
-}
-bool? get authorizedVerifyAge => _authorizedVerifyAge;
-set authorizedVerifyAge(bool? val) {
- _authorizedVerifyAge = val;
- _set({"authorizedVerifyAge": val});
-}
-bool? get authorizedVerifyCommunityID => _authorizedVerifyCommunityID;
-set authorizedVerifyCommunityID(bool? val) {
- _authorizedVerifyCommunityID = val;
- _set({"authorizedVerifyCommunityID": val});
-}
-bool? get authorizedWriteDG17 => _authorizedWriteDG17;
-set authorizedWriteDG17(bool? val) {
- _authorizedWriteDG17 = val;
- _set({"authorizedWriteDG17": val});
-}
-bool? get authorizedWriteDG18 => _authorizedWriteDG18;
-set authorizedWriteDG18(bool? val) {
- _authorizedWriteDG18 = val;
- _set({"authorizedWriteDG18": val});
-}
-bool? get authorizedWriteDG19 => _authorizedWriteDG19;
-set authorizedWriteDG19(bool? val) {
- _authorizedWriteDG19 = val;
- _set({"authorizedWriteDG19": val});
-}
-bool? get authorizedWriteDG20 => _authorizedWriteDG20;
-set authorizedWriteDG20(bool? val) {
- _authorizedWriteDG20 = val;
- _set({"authorizedWriteDG20": val});
-}
-bool? get authorizedWriteDG21 => _authorizedWriteDG21;
-set authorizedWriteDG21(bool? val) {
- _authorizedWriteDG21 = val;
- _set({"authorizedWriteDG21": val});
-}
-bool? get autoSettings => _autoSettings;
-set autoSettings(bool? val) {
- _autoSettings = val;
- _set({"autoSettings": val});
-}
-bool? get auxVerificationCommunityID => _auxVerificationCommunityID;
-set auxVerificationCommunityID(bool? val) {
- _auxVerificationCommunityID = val;
- _set({"auxVerificationCommunityID": val});
-}
-bool? get auxVerificationDateOfBirth => _auxVerificationDateOfBirth;
-set auxVerificationDateOfBirth(bool? val) {
- _auxVerificationDateOfBirth = val;
- _set({"auxVerificationDateOfBirth": val});
-}
-RFIDAccessControlProcedureType? get baseSMProcedure => _baseSMProcedure;
-set baseSMProcedure(RFIDAccessControlProcedureType? val) {
- _baseSMProcedure = val;
- _set({"baseSMProcedure": val?.value});
-}
-int get defaultReadingBufferSize => _defaultReadingBufferSize;
-set defaultReadingBufferSize(int val) {
- _defaultReadingBufferSize = val;
- _set({"defaultReadingBufferSize": val});
-}
-EDLDataGroups get eDLDataGroups => _eDLDataGroups;
-set eDLDataGroups(EDLDataGroups val) {
- (_eDLDataGroups = val)._apply(this);
-}
-EIDDataGroups get eIDDataGroups => _eIDDataGroups;
-set eIDDataGroups(EIDDataGroups val) {
- (_eIDDataGroups = val)._apply(this);
-}
-EPassportDataGroups get ePassportDataGroups => _ePassportDataGroups;
-set ePassportDataGroups(EPassportDataGroups val) {
- (_ePassportDataGroups = val)._apply(this);
-}
-String? get eSignPINDefault => _eSignPINDefault;
-set eSignPINDefault(String? val) {
- _eSignPINDefault = val;
- _set({"eSignPINDefault": val});
-}
-String? get eSignPINNewValue => _eSignPINNewValue;
-set eSignPINNewValue(String? val) {
- _eSignPINNewValue = val;
- _set({"eSignPINNewValue": val});
-}
-Allows you to deserialize object.
-static RFIDScenario fromJson(jsonObject) {
- var result = RFIDScenario();
- result.testSetters = {};
-
- result.paceStaticBinding = jsonObject["paceStaticBinding"];
- result.onlineTA = jsonObject["onlineTA"];
- result.writeEid = jsonObject["writeEid"];
- result.universalAccessRights = jsonObject["universalAccessRights"];
- result.authorizedRestrictedIdentification =
- jsonObject["authorizedRestrictedIdentification"];
- result.auxVerificationCommunityID =
- jsonObject["auxVerificationCommunityID"];
- result.auxVerificationDateOfBirth =
- jsonObject["auxVerificationDateOfBirth"];
- result.skipAA = jsonObject["skipAA"];
- result.strictProcessing = jsonObject["strictProcessing"];
- result.pkdDSCertPriority = jsonObject["pkdDSCertPriority"];
- result.pkdUseExternalCSCA = jsonObject["pkdUseExternalCSCA"];
- result.trustedPKD = jsonObject["trustedPKD"];
- result.passiveAuth = jsonObject["passiveAuth"];
- result.useSFI = jsonObject["useSFI"];
- result.readEPassport = jsonObject["readEPassport"];
- result.readEID = jsonObject["readEID"];
- result.readEDL = jsonObject["readEDL"];
- result.authorizedSTSignature = jsonObject["authorizedSTSignature"];
- result.authorizedSTQSignature = jsonObject["authorizedSTQSignature"];
- result.authorizedWriteDG17 = jsonObject["authorizedWriteDG17"];
- result.authorizedWriteDG18 = jsonObject["authorizedWriteDG18"];
- result.authorizedWriteDG19 = jsonObject["authorizedWriteDG19"];
- result.authorizedWriteDG20 = jsonObject["authorizedWriteDG20"];
- result.authorizedWriteDG21 = jsonObject["authorizedWriteDG21"];
- result.authorizedVerifyAge = jsonObject["authorizedVerifyAge"];
- result.authorizedVerifyCommunityID =
- jsonObject["authorizedVerifyCommunityID"];
- result.authorizedPrivilegedTerminal =
- jsonObject["authorizedPrivilegedTerminal"];
- result.authorizedCANAllowed = jsonObject["authorizedCANAllowed"];
- result.authorizedPINManagement = jsonObject["authorizedPINManagement"];
- result.authorizedInstallCert = jsonObject["authorizedInstallCert"];
- result.authorizedInstallQCert = jsonObject["authorizedInstallQCert"];
- result.applyAmendments = jsonObject["applyAmendments"];
- result.autoSettings = jsonObject["autoSettings"];
- result.proceedReadingAlways = jsonObject["proceedReadingAlways"];
-
- result.readingBuffer = jsonObject["readingBuffer"];
- result.onlineTAToSignDataType = jsonObject["onlineTAToSignDataType"];
- result.defaultReadingBufferSize = jsonObject["defaultReadingBufferSize"];
- result.signManagementAction =
- SignManagementAction.getByValue(jsonObject["signManagementAction"]);
- result.profilerType =
- RFIDSDKProfilerType.getByValue(jsonObject["profilerType"]);
- result.authProcType =
- RFIDAuthenticationProcedureType.getByValue(jsonObject["authProcType"]);
- result.baseSMProcedure = RFIDAccessControlProcedureType.getByValue(
- jsonObject["baseSMProcedure"]);
- result.pacePasswordType =
- RFIDPasswordType.getByValue(jsonObject["pacePasswordType"]);
- result.terminalType =
- RFIDTerminalType.getByValue(jsonObject["terminalType"]);
-
- result.password = jsonObject["password"];
- result.pkdPA = jsonObject["pkdPA"];
- result.pkdEAC = jsonObject["pkdEAC"];
- result.mrz = jsonObject["mrz"];
- result.eSignPINDefault = jsonObject["eSignPINDefault"];
- result.eSignPINNewValue = jsonObject["eSignPINNewValue"];
-
- result.eDLDataGroups = EDLDataGroups.fromJson(jsonObject["eDLDataGroups"]);
- result.ePassportDataGroups =
- EPassportDataGroups.fromJson(jsonObject["ePassportDataGroups"]);
- result.eIDDataGroups = EIDDataGroups.fromJson(jsonObject["eIDDataGroups"]);
-
- return result;
-}
-int? get onlineTAToSignDataType => _onlineTAToSignDataType;
-set onlineTAToSignDataType(int? val) {
- _onlineTAToSignDataType = val;
- _set({"onlineTAToSignDataType": val});
-}
-RFIDPasswordType? get pacePasswordType => _pacePasswordType;
-set pacePasswordType(RFIDPasswordType? val) {
- _pacePasswordType = val;
- _set({"pacePasswordType": val?.value});
-}
-bool? get paceStaticBinding => _paceStaticBinding;
-set paceStaticBinding(bool? val) {
- _paceStaticBinding = val;
- _set({"paceStaticBinding": val});
-}
-bool? get passiveAuth => _passiveAuth;
-set passiveAuth(bool? val) {
- _passiveAuth = val;
- _set({"passiveAuth": val});
-}
-String? get password => _password;
-set password(String? val) {
- _password = val;
- _set({"password": val});
-}
-bool? get pkdDSCertPriority => _pkdDSCertPriority;
-set pkdDSCertPriority(bool? val) {
- _pkdDSCertPriority = val;
- _set({"pkdDSCertPriority": val});
-}
-bool? get pkdUseExternalCSCA => _pkdUseExternalCSCA;
-set pkdUseExternalCSCA(bool? val) {
- _pkdUseExternalCSCA = val;
- _set({"pkdUseExternalCSCA": val});
-}
-bool? get proceedReadingAlways => _proceedReadingAlways;
-set proceedReadingAlways(bool? val) {
- _proceedReadingAlways = val;
- _set({"proceedReadingAlways": val});
-}
-RFIDSDKProfilerType? get profilerType => _profilerType;
-set profilerType(RFIDSDKProfilerType? val) {
- _profilerType = val;
- _set({"profilerType": val?.value});
-}
-bool? get readEPassport => _readEPassport;
-set readEPassport(bool? val) {
- _readEPassport = val;
- _set({"readEPassport": val});
-}
-int? get readingBuffer => _readingBuffer;
-set readingBuffer(int? val) {
- _readingBuffer = val;
- _set({"readingBuffer": val});
-}
-SignManagementAction? get signManagementAction => _signManagementAction;
-set signManagementAction(SignManagementAction? val) {
- _signManagementAction = val;
- _set({"signManagementAction": val?.value});
-}
-bool? get strictProcessing => _strictProcessing;
-set strictProcessing(bool? val) {
- _strictProcessing = val;
- _set({"strictProcessing": val});
-}
-RFIDTerminalType? get terminalType => _terminalType;
-set terminalType(RFIDTerminalType? val) {
- _terminalType = val;
- _set({"terminalType": val?.value});
-}
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "paceStaticBinding": paceStaticBinding,
- "onlineTA": onlineTA,
- "writeEid": writeEid,
- "universalAccessRights": universalAccessRights,
- "authorizedRestrictedIdentification":
- authorizedRestrictedIdentification,
- "auxVerificationCommunityID": auxVerificationCommunityID,
- "auxVerificationDateOfBirth": auxVerificationDateOfBirth,
- "skipAA": skipAA,
- "strictProcessing": strictProcessing,
- "pkdDSCertPriority": pkdDSCertPriority,
- "pkdUseExternalCSCA": pkdUseExternalCSCA,
- "trustedPKD": trustedPKD,
- "passiveAuth": passiveAuth,
- "useSFI": useSFI,
- "readEPassport": readEPassport,
- "readEID": readEID,
- "readEDL": readEDL,
- "authorizedSTSignature": authorizedSTSignature,
- "authorizedSTQSignature": authorizedSTQSignature,
- "authorizedWriteDG17": authorizedWriteDG17,
- "authorizedWriteDG18": authorizedWriteDG18,
- "authorizedWriteDG19": authorizedWriteDG19,
- "authorizedWriteDG20": authorizedWriteDG20,
- "authorizedWriteDG21": authorizedWriteDG21,
- "authorizedVerifyAge": authorizedVerifyAge,
- "authorizedVerifyCommunityID": authorizedVerifyCommunityID,
- "authorizedPrivilegedTerminal": authorizedPrivilegedTerminal,
- "authorizedCANAllowed": authorizedCANAllowed,
- "authorizedPINManagement": authorizedPINManagement,
- "authorizedInstallCert": authorizedInstallCert,
- "authorizedInstallQCert": authorizedInstallQCert,
- "applyAmendments": applyAmendments,
- "autoSettings": autoSettings,
- "proceedReadingAlways": proceedReadingAlways,
- "readingBuffer": readingBuffer,
- "onlineTAToSignDataType": onlineTAToSignDataType,
- "defaultReadingBufferSize": defaultReadingBufferSize,
- "signManagementAction": signManagementAction?.value,
- "profilerType": profilerType?.value,
- "authProcType": authProcType?.value,
- "baseSMProcedure": baseSMProcedure?.value,
- "pacePasswordType": pacePasswordType?.value,
- "terminalType": terminalType?.value,
- "password": password,
- "pkdPA": pkdPA,
- "pkdEAC": pkdEAC,
- "mrz": mrz,
- "eSignPINDefault": eSignPINDefault,
- "eSignPINNewValue": eSignPINNewValue,
- "eDLDataGroups": eDLDataGroups.toJson(),
- "ePassportDataGroups": ePassportDataGroups.toJson(),
- "eIDDataGroups": eIDDataGroups.toJson(),
- }.clearNulls();
-bool? get trustedPKD => _trustedPKD;
-set trustedPKD(bool? val) {
- _trustedPKD = val;
- _set({"trustedPKD": val});
-}
-bool? get universalAccessRights => _universalAccessRights;
-set universalAccessRights(bool? val) {
- _universalAccessRights = val;
- _set({"universalAccessRights": val});
-}
-Used to describe the results of work with the SDK within the context -of the current communication session with electronic document.
-List of containers to store information about the supported procedures -of authentication and secure data access within the context of the session.
-List<AccessControlProcedureType> get accessControls => _accessControls;
-List of containers to store information about the involved ap-plications -of electronic document.
-List<Application> get applications => _applications;
-Set of electronic document chip characteristics.
-CardProperties? get cardProperties => _cardProperties;
-List of data groups.
-List<RFIDDataFileType>? get dataGroups => _dataGroups;
-Sign of support of RFID-chip for extended length commands of reading.
-RFIDErrorCodes get extLeSupport => _extLeSupport;
-Allows you to deserialize object.
-static RFIDSessionData? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDSessionData();
-
- result._totalBytesReceived = jsonObject["totalBytesReceived"];
- result._totalBytesSent = jsonObject["totalBytesSent"];
- result._status = RFIDErrorCodes.getByValue(jsonObject["status"])!;
- result._extLeSupport =
- RFIDErrorCodes.getByValue(jsonObject["extLeSupport"])!;
- result._processTime = jsonObject["processTime"];
- result._cardProperties =
- CardProperties.fromJson(jsonObject["cardProperties"]);
- for (var item in jsonObject["accessControls"])
- result._accessControls.addSafe(AccessControlProcedureType.fromJson(item));
- for (var item in jsonObject["applications"])
- result._applications.addSafe(Application.fromJson(item));
- for (var item in jsonObject["securityObjects"])
- result._securityObjects.addSafe(SecurityObject.fromJson(item));
- for (var item in jsonObject["dataFields"])
- result._dataFields.addSafe(DataField.fromJson(item));
- if (jsonObject["dataGroups"] != null) {
- result._dataGroups = [];
- for (var item in jsonObject["dataGroups"])
- result._dataGroups!.addSafe(RFIDDataFileType.getByValue(item));
- }
-
- return result;
-}
-Total time of all operations performed during the session, ms.
-int get processTime => _processTime;
-ist of containers to store information about the detected -document security objects.
-List<SecurityObject> get securityObjects => _securityObjects;
-Status.
-RFIDErrorCodes get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "cardProperties": cardProperties?.toJson(),
- "totalBytesReceived": totalBytesReceived,
- "totalBytesSent": totalBytesSent,
- "status": status.value,
- "extLeSupport": extLeSupport.value,
- "processTime": processTime,
- "accessControls": accessControls.map((e) => e.toJson()).toList(),
- "applications": applications.map((e) => e.toJson()).toList(),
- "securityObjects": securityObjects.map((e) => e.toJson()).toList(),
- "dataFields": dataFields.map((e) => e.toJson()).toList(),
- "dataGroups": dataGroups?.map((e) => e.value).toList(),
- }.clearNulls();
-Total number of bytes received from the RFID-chip during the whole session.
-int get totalBytesReceived => _totalBytesReceived;
-Total number of bytes transmitted to the RFID-chip during the whole session.
-int get totalBytesSent => _totalBytesSent;
-Container for a RFID related scanning statuses.
-Acitve authentication status.
-CheckResult get aa => _aa;
-Basics access control status.
-CheckResult get bac => _bac;
-Chip authentication status.
-CheckResult get ca => _ca;
-Allows you to deserialize object.
-static RFIDStatus? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDStatus();
-
- result._pa = CheckResult.getByValue(jsonObject["pa"])!;
- result._ca = CheckResult.getByValue(jsonObject["ca"])!;
- result._aa = CheckResult.getByValue(jsonObject["aa"])!;
- result._ta = CheckResult.getByValue(jsonObject["ta"])!;
- result._bac = CheckResult.getByValue(jsonObject["bac"])!;
- result._pace = CheckResult.getByValue(jsonObject["pace"])!;
- result._overallStatus =
- CheckResult.getByValue(jsonObject["overallStatus"])!;
-
- return result;
-}
-Summary of all RFID results.
-CheckResult get overallStatus => _overallStatus;
-Passive authentication status.
-CheckResult get pa => _pa;
-Password authenticated connection establishment status.
-CheckResult get pace => _pace;
-Terminal authentication status.
-CheckResult get ta => _ta;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "overallStatus": overallStatus.value,
- "pa": pa.value,
- "ca": ca.value,
- "aa": aa.value,
- "ta": ta.value,
- "bac": bac.value,
- "pace": pace.value,
- }.clearNulls();
-Not defined.
- - -RFIDTerminalType(0)
- Inspection system.
- - -RFIDTerminalType(1)
- Authentication terminal
- - -RFIDTerminalType(2)
- Signature terminal.
- - -RFIDTerminalType(3)
- Unauthenticated terminal.
- - -RFIDTerminalType(4)
- [UNDEFINED, INSPECTION_SYSTEM, AUTHENTICATION_TERMINAL, SIGNATURE_TERMINAL, UNAUTHENTICATED_TERMINAL]
- const RFIDTerminalType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Allows you to deserialize object.
-static RFIDValidity? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDValidity();
-
- result._notAfter = RFIDValue.fromJson(jsonObject["notAfter"]);
- result._notBefore = RFIDValue.fromJson(jsonObject["notBefore"]);
-
- return result;
-}
-RFIDValue? get notAfter => _notAfter;
-RFIDValue? get notBefore => _notBefore;
-String? get data => _data;
-String? get format => _format;
-Allows you to deserialize object.
-static RFIDValue? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RFIDValue();
-
- result._length = jsonObject["length"];
- result._type = jsonObject["type"];
- result._status = jsonObject["status"];
- result._data = jsonObject["data"];
- result._format = jsonObject["format"];
-
- return result;
-}
-int get length => _length;
-int get status => _status;
-int get type => _type;
-Image processing configuration.
-RecognizeConfig.withOnlineProcessingConfig(
- OnlineProcessingConfig onlineProcessingConfig,
- RecognizeData recognizeData)
- : _scenario = null,
- _onlineProcessingConfig = onlineProcessingConfig,
- _image = recognizeData.image,
- _data = recognizeData.data,
- _images = recognizeData.images,
- _imageInputData = recognizeData.imageInputData;
-RecognizeConfig.withScenario(Scenario scenario, RecognizeData recognizeData)
- : _scenario = scenario,
- _onlineProcessingConfig = null,
- _image = recognizeData.image,
- _data = recognizeData.data,
- _images = recognizeData.images,
- _imageInputData = recognizeData.imageInputData;
-Binary for processing
-Only one of image, data, images, imageInputData can be set
-at a time. All the others must be null.
Uint8List? get data => _data;
-Portrait photo from an external source.
-Requires network connection.
-Uint8List? extPortrait;
-@visibleForTesting
-static RecognizeConfig? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = RecognizeConfig._empty();
-
- result._scenario = Scenario.getByValue(jsonObject["scenario"]);
- result._onlineProcessingConfig =
- OnlineProcessingConfig.fromJson(jsonObject["onlineProcessingConfig"]);
- result.livePortrait = _bytesFromBase64(jsonObject["livePortrait"]);
- result.extPortrait = _bytesFromBase64(jsonObject["extPortrait"]);
- result.oneShotIdentification = jsonObject["oneShotIdentification"];
- result._image = _bytesFromBase64(jsonObject["image"]);
- result._data = _bytesFromBase64(jsonObject["data"]);
- if (jsonObject["images"] != null) {
- result._images = [];
- for (var item in jsonObject["images"])
- result._images!.addSafe(_bytesFromBase64(item));
- }
- if (jsonObject["imageInputData"] != null) {
- result._imageInputData = [];
- for (var item in jsonObject["imageInputData"])
- result._imageInputData!.addSafe(ImageInputData.fromJson(item));
- }
-
- return result;
-}
-Image for processing
-Only one of image, data, images, imageInputData can be set
-at a time. All the others must be null.
Uint8List? get image => _image;
-Images(with input data) for processing
-Only one of image, data, images, imageInputData can be set
-at a time. All the others must be null.
List<ImageInputData>? get imageInputData => _imageInputData;
-Images for processing
-Only one of image, data, images, imageInputData can be set
-at a time. All the others must be null.
List<Uint8List>? get images => _images;
-Live portrait photo.
-Requires network connection.
-Uint8List? livePortrait;
-This parameter is for processing an image that contains a person and -a document and compare the portrait photo from the document with -the person's face. It works only in the single-frame processing, -but not in the video frame processing. Requires network connection.
-bool oneShotIdentification = false;
-Configuration class for online processing.
-/// Requires network connection.
-OnlineProcessingConfig? get onlineProcessingConfig => _onlineProcessingConfig;
-Documents processing scenario.
-Scenario? get scenario => _scenario;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "scenario": scenario?.value,
- "onlineProcessingConfig": onlineProcessingConfig?.toJson(),
- "oneShotIdentification": oneShotIdentification,
- "livePortrait": _bytesToBase64(livePortrait),
- "extPortrait": _bytesToBase64(extPortrait),
- "image": _bytesToBase64(image),
- "data": _bytesToBase64(data),
- "images": images?.map((e) => _bytesToBase64(e)).toList(),
- "imageInputData": imageInputData?.map((e) => e.toJson()).toList(),
- }.clearNulls();
-Insures that RecognizeConfig has exactly one of four parameters set: -image, data, images, imageInputData
-RecognizeData.withData(Uint8List data)
- : _image = null,
- _data = data,
- _images = null,
- _imageInputData = null;
-RecognizeData.withImage(Uint8List image)
- : _image = image,
- _data = null,
- _images = null,
- _imageInputData = null;
-RecognizeData.withImageInputData(List<ImageInputData> imageInputData)
- : _image = null,
- _data = null,
- _images = null,
- _imageInputData = imageInputData;
-RecognizeData.withImages(List<Uint8List> images)
- : _image = null,
- _data = null,
- _images = images,
- _imageInputData = null;
-Uint8List? get data => _data;
-Uint8List? get image => _image;
-List<ImageInputData>? get imageInputData => _imageInputData;
-List<Uint8List>? get images => _images;
-int get bottom => _bottom;
-Allows you to deserialize object.
-static Rect? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Rect();
-
- result._bottom = jsonObject["bottom"];
- result._top = jsonObject["top"];
- result._left = jsonObject["left"];
- result._right = jsonObject["right"];
-
- return result;
-}
-int get left => _left;
-int get right => _right;
-int get top => _top;
-Enumeration contains a pool of constants that determine the type of resulting -data formed during the data scanning and processing cycle and passed -to the user application.
-No result.
- - -ResultType(-1)
- Stores a graphic image.
- - -ResultType(0)
- Represented as binary array which contains image of the image graphic file.
- - -ResultType(1)
- Serves for storing text results of MRZ, document filling and bar-codes reading.
- - -ResultType(2)
- Serves for storing and passing to the user application of results of bar-codes -areas search on the scanned document page and their.
- - -ResultType(3)
- Serves for storing and passing to the user application of results of bar-codes -areas search on the scanned document page and their reading in binary non-formatted code.
- - -ResultType(5)
- Serves for storing graphic results of document filling area and bar-codes reading.
- - -ResultType(6)
- Serves for storing the information on document MRZ printing quality check results.
- - -ResultType(7)
- Serves for storing information on candidate documents and passing it to the user -application when performing the recognition of the document type.
- - -ResultType(8)
- Contains information on one candidate document when determining the document type.
- - -ResultType(9)
- Not used. Serves for storing the full list of documents stored in the current -document database and passing it to the user application.
- - -ResultType(10)
- Serves for storing the results of comparing the MRZ text data, document filling -area data, bar-codes data and data retrieved from RFID-chip memory and passing -it to the user application.
- - -ResultType(15)
- Result stores a graphic image without compression.
- - -ResultType(16)
- Result serves for storing text results of MRZ, document filling and bar-codes reading.
- - -ResultType(17)
- Result serves for storing text results of MRZ, document filling and bar-codes reading.
- - -ResultType(18)
- Serves for storing graphic results of document filling area and bar-codes reading.
- - -ResultType(19)
- Serves for storing the result of document authenticity check using -the images for different lighting schemes and passing it to the user -application.
- - -ResultType(20)
- Not used
- - -ResultType(21)
- Not used
- - -ResultType(22)
- Stores a graphic image in without compression and passing it to the user application.
- - -ResultType(23)
- Stores a graphic image in without compression and passing it to the user application.
- - -ResultType(24)
- Represented as binary array which contains array if data erade from magnetic stripe.
- - -ResultType(25)
- Serves for storing text results of MRZ, document filling and bar-codes reading.
- - -ResultType(26)
- Represented as binary array which contains image of the graphic field image graphic file.
- - -ResultType(27)
- Serves for storing the result of documents database check.
- - -ResultType(28)
- Represented as binary array which contains ISO fingerprint template.
- - -ResultType(29)
- Used for storing input image quality check results list.
- - -ResultType(30)
- Serves for storing the result of document authenticity check using live -portrait image.
- - -ResultType(32)
- Stores information about operations status.
- - -ResultType(33)
- Serves for storing the result of document authenticity check using portrait images.
- - -ResultType(34)
- Serves for storing the result of document authenticity check using external portait.
- - -ResultType(35)
- Used for storing text results list.
- - -ResultType(36)
- Used for storing images results list.
- - -ResultType(37)
- Serves to store RFID session as binary data.
- - -ResultType(48)
- Serves to store the encrypted data object.
- - -ResultType(49)
- Serves to store the encrypted license key.
- - -ResultType(50)
- Used for storing MRZ position.
- - -ResultType(61)
- Used for storing barcode position.
- - -ResultType(62)
- Used for storing document position.
- - -ResultType(85)
- Not used
- - -ResultType(100)
- Servers for storing the data reading results from the RFID-chip in a form -of a list of the logically separated data groups.
- - -ResultType(101)
- Servers for storing the results of data reading from the RFID-chip in a form -of a list of logically separated text data (text fields).
- - -ResultType(102)
- Servers for storing the results of data reading from the RFID- chip in a form -of a list of logically separated graphic data (images, graphic fields).
- - -ResultType(103)
- Servers for storing the data reading results from the RFID-chip in a form -of a list of the logically separated data groups.
- - -ResultType(104)
- Servers for storing the results of data reading in a form of a list of objects -of the original binary representation of the graphics in memory of the RFID-chip.
- - -ResultType(105)
- [NONE, EMPTY, RAW_IMAGE, FILE_IMAGE, MRZ_OCR_EXTENDED, BARCODES, GRAPHICS, MRZ_TEST_QUALITY, DOCUMENT_TYPES_CANDIDATES, CHOSEN_DOCUMENT_TYPE_CANDIDATE, DOCUMENTS_INFO_LIST, OCR_LEXICAL_ANALYZE, RAW_UN…
- const ResultType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Class describing results returned on completion of Document Reader work.
-Authenticity results.
-AuthenticityResult? get authenticityResult => _authenticityResult;
-Barcode results.
-BarcodeResult? get barcodeResult => _barcodeResult;
-Indicates which page of the document contains an RFID chip (0 if there's -no page containing it). Requires document type recognition, otherwise 1 by default.
-int get chipPage => _chipPage;
-Method returns containers by result type. If result type doesn't exist, -the result of the search will be null.
-Returns original containers from rawResult including information about the transaction.
-Future<String?> containers(List<ResultType> resultType) async {
- List<int> converted = [];
- for (ResultType item in resultType) converted.add(item.value);
- return await _bridge.invokeMethod("containers", [rawResult, converted]);
-}
-Document type results.
-List<DocumentType>? get documentType => _documentType;
-Indicates how much time has been required for document processing, milliseconds.
-int get elapsedTime => _elapsedTime;
-Indicates how much time has been required for RFID chip processing, milliseconds.
-int get elapsedTimeRFID => _elapsedTimeRFID;
-Method returns only containers for ResultType.INTERNAL_RFID_SESSION, -ResultType.INTERNAL_ENCRYPTED_RCL and ResultType.INTERNAL_LICENSE values.
-For more details, see containers method. -Returns all encrypted containers from rawResult to reprocess data on the server side.
-Future<String?> encryptedContainers() async {
- return await _bridge.invokeMethod("encryptedContainers", [rawResult]);
-}
-Allows you to deserialize object.
-static Results? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Results();
-
- result._chipPage = jsonObject["chipPage"];
- result._processingFinishedStatus = ProcessingFinishedStatus.getByValue(
- jsonObject["processingFinishedStatus"])!;
- result._elapsedTime = jsonObject["elapsedTime"];
- result._elapsedTimeRFID = jsonObject["elapsedTimeRFID"];
- result._morePagesAvailable = jsonObject["morePagesAvailable"];
- result._graphicResult = GraphicResult.fromJson(jsonObject["graphicResult"]);
- result._textResult = TextResult.fromJson(jsonObject["textResult"]);
- if (jsonObject["documentPosition"] != null) {
- result._documentPosition = [];
- for (var item in jsonObject["documentPosition"])
- result._documentPosition!.addSafe(Position.fromJson(item));
- }
- if (jsonObject["barcodePosition"] != null) {
- result._barcodePosition = [];
- for (var item in jsonObject["barcodePosition"])
- result._barcodePosition!.addSafe(Position.fromJson(item));
- }
- if (jsonObject["mrzPosition"] != null) {
- result._mrzPosition = [];
- for (var item in jsonObject["mrzPosition"])
- result._mrzPosition!.addSafe(Position.fromJson(item));
- }
- if (jsonObject["imageQuality"] != null) {
- result._imageQuality = [];
- for (var item in jsonObject["imageQuality"])
- result._imageQuality!.addSafe(ImageQualityGroup.fromJson(item));
- }
- if (jsonObject["documentType"] != null) {
- result._documentType = [];
- for (var item in jsonObject["documentType"])
- result._documentType!.addSafe(DocumentType.fromJson(item));
- }
- result._rawResult = jsonObject["rawResult"];
- result._rfidSessionData =
- RFIDSessionData.fromJson(jsonObject["rfidSessionData"]);
- result._authenticityResult =
- AuthenticityResult.fromJson(jsonObject["authenticityResult"]);
- result._barcodeResult = BarcodeResult.fromJson(jsonObject["barcodeResult"]);
- result._status = ResultsStatus.fromJson(jsonObject["status"])!;
- result._vdsncData = VDSNCData.fromJson(jsonObject["vdsncData"]);
- result._transactionInfo =
- TransactionInfo.fromJson(jsonObject["transactionInfo"]);
-
- return result;
-}
-Allows you to get an image of a graphic field based on a source type -and page index.
-Future<GraphicField?> graphicFieldByTypeSource(
- GraphicFieldType fieldType,
- ResultType source,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldByTypeSource",
- [
- rawResult,
- fieldType.value,
- source.value,
- ],
- );
- if (result == null) return null;
- return GraphicField.fromJson(json.decode(result));
-}
-Allows you to get an image of a graphic field based on a source type -and page index.
-Future<GraphicField?> graphicFieldByTypeSourcePageIndex(
- GraphicFieldType fieldType,
- ResultType source,
- int pageIndex,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldByTypeSourcePageIndex",
- [
- rawResult,
- fieldType.value,
- source.value,
- pageIndex,
- ],
- );
- if (result == null) return null;
- return GraphicField.fromJson(json.decode(result));
-}
-Allows you to get an image of a graphic field based on a source type, -page index and light type.
-Future<GraphicField?> graphicFieldByTypeSourcePageIndexLight(
- GraphicFieldType fieldType,
- ResultType source,
- int pageIndex,
- Lights light,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldByTypeSourcePageIndex",
- [
- rawResult,
- fieldType.value,
- source.value,
- pageIndex,
- light.value,
- ],
- );
- if (result == null) return null;
- return GraphicField.fromJson(json.decode(result));
-}
-Allows you to get an image of a graphic field.
-Future<Uint8List?> graphicFieldImageByType(
- GraphicFieldType fieldType,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldImageByType",
- [
- rawResult,
- fieldType.value,
- ],
- );
- if (result == null) return null;
- // return Uri.parse("data:image/png;base64," + result);
- return _bytesFromBase64(result);
-}
-Allows you to get an image of a graphic field based on a source type.
-Future<Uint8List?> graphicFieldImageByTypeSource(
- GraphicFieldType fieldType,
- ResultType source,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldImageByTypeSource",
- [
- rawResult,
- fieldType.value,
- source.value,
- ],
- );
- if (result == null) return null;
- return _bytesFromBase64(result);
-}
-Allows you to get an image of a graphic field based on a source type -and page index.
-Future<Uint8List?> graphicFieldImageByTypeSourcePageIndex(
- GraphicFieldType fieldType,
- ResultType source,
- int pageIndex,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldImageByTypeSourcePageIndex",
- [
- rawResult,
- fieldType.value,
- source.value,
- pageIndex,
- ],
- );
- if (result == null) return null;
- return _bytesFromBase64(result);
-}
-Allows you to get an image of a graphic field based on a source type, -page index and light type.
-Future<Uint8List?> graphicFieldImageByTypeSourcePageIndexLight(
- GraphicFieldType fieldType,
- ResultType source,
- int pageIndex,
- Lights light,
-) async {
- String? result = await _bridge.invokeMethod(
- "graphicFieldImageByTypeSourcePageIndexLight",
- [
- rawResult,
- fieldType.value,
- source.value,
- pageIndex,
- light.value,
- ],
- );
- if (result == null) return null;
- return _bytesFromBase64(result);
-}
-Graphic results.
-GraphicResult? get graphicResult => _graphicResult;
-Image quality results.
-List<ImageQualityGroup>? get imageQuality => _imageQuality;
-Indicates how many pages of a document remains to process. -Requires Document Type recognition, otherwise 0 by default.
-int get morePagesAvailable => _morePagesAvailable;
-Document processing finish status, one of RGLProcessingFinishedStatus values.
-ProcessingFinishedStatus get processingFinishedStatus =>
- _processingFinishedStatus;
-Raw results, i.e. in their initial view.
-String get rawResult => _rawResult;
-RFID session data.
-RFIDSessionData? get rfidSessionData => _rfidSessionData;
-Status information for each operation.
-ResultsStatus get status => _status;
-Allows you to get an instance of a text field.
-Future<TextField?> textFieldByType(
- FieldType fieldType,
-) async {
- String? result = await _bridge.invokeMethod(
- "textFieldByType",
- [
- rawResult,
- fieldType.value,
- ],
- );
- if (result == null) return null;
- return TextField.fromJson(json.decode(result));
-}
-Allows you to get an instance of a text field based on LCID.
-Future<TextField?> textFieldByTypeLcid(
- FieldType fieldType,
- LCID lcid,
-) async {
- String? result = await _bridge.invokeMethod(
- "textFieldByTypeLcid",
- [
- rawResult,
- fieldType.value,
- lcid.value,
- ],
- );
- if (result == null) return null;
- return TextField.fromJson(json.decode(result));
-}
-Allows you to get a value of a text field.
-Future<String?> textFieldValueByType(
- FieldType fieldType,
-) async {
- return await _bridge.invokeMethod(
- "textFieldValueByType",
- [
- rawResult,
- fieldType.value,
- ],
- );
-}
-Allows you to get a value of a text field based on LCID.
-Future<String?> textFieldValueByTypeLcid(
- FieldType fieldType,
- LCID lcid,
-) async {
- return await _bridge.invokeMethod(
- "textFieldValueByTypeLcid",
- [
- rawResult,
- fieldType.value,
- lcid.value,
- ],
- );
-}
-Allows you to get a value of a text field based on LCID and a source type.
-Future<String?> textFieldValueByTypeLcidSource(
- FieldType fieldType,
- LCID lcid,
- ResultType source,
-) async {
- return await _bridge.invokeMethod(
- "textFieldValueByTypeLcidSource",
- [
- rawResult,
- fieldType.value,
- lcid.value,
- source.value,
- ],
- );
-}
-Allows you to get a value of a text field based on LCID, a source type -and its originality.
-Future<String?> textFieldValueByTypeLcidSourceOriginal(
- FieldType fieldType,
- LCID lcid,
- ResultType source,
- bool original,
-) async {
- return await _bridge.invokeMethod(
- "textFieldValueByTypeLcidSourceOriginal",
- [
- rawResult,
- fieldType.value,
- lcid.value,
- source.value,
- original,
- ],
- );
-}
-Allows you to get a value of a text field based on a source type.
-Future<String?> textFieldValueByTypeSource(
- FieldType fieldType,
- ResultType source,
-) async {
- return await _bridge.invokeMethod(
- "textFieldValueByTypeSource",
- [
- rawResult,
- fieldType.value,
- source.value,
- ],
- );
-}
-Allows you to get a value of a text field based on a source type and -its originality.
-Future<String?> textFieldValueByTypeSourceOriginal(
- FieldType fieldType,
- ResultType source,
- bool original,
-) async {
- return await _bridge.invokeMethod(
- "textFieldValueByTypeSourceOriginal",
- [
- rawResult,
- fieldType.value,
- source.value,
- original,
- ],
- );
-}
-Textual results.
-TextResult? get textResult => _textResult;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "documentType": documentType?.map((e) => e.toJson()).toList(),
- "documentPosition": documentPosition?.map((e) => e.toJson()).toList(),
- "barcodePosition": barcodePosition?.map((e) => e.toJson()).toList(),
- "mrzPosition": mrzPosition?.map((e) => e.toJson()).toList(),
- "imageQuality": imageQuality?.map((e) => e.toJson()).toList(),
- "textResult": textResult?.toJson(),
- "graphicResult": graphicResult?.toJson(),
- "status": status.toJson(),
- "authenticityResult": authenticityResult?.toJson(),
- "rfidSessionData": rfidSessionData?.toJson(),
- "barcodeResult": barcodeResult?.toJson(),
- "vdsncData": vdsncData?.toJson(),
- "chipPage": chipPage,
- "processingFinishedStatus": processingFinishedStatus.value,
- "morePagesAvailable": morePagesAvailable,
- "elapsedTime": elapsedTime,
- "elapsedTimeRFID": elapsedTimeRFID,
- "rawResult": rawResult,
- "transactionInfo": transactionInfo?.toJson(),
- }.clearNulls();
-TransactionInfo? get transactionInfo => _transactionInfo;
-Visible Digital Seal data.
-VDSNCData? get vdsncData => _vdsncData;
-Provision of document verification status.
-Container for an optical related scanning statuses.
-OpticalStatus get detailsOptical => _detailsOptical;
-Container for a RFID related scanning statuses.
-RFIDStatus get detailsRFID => _detailsRFID;
-Allows you to deserialize object.
-static ResultsStatus? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = ResultsStatus();
-
- result._overallStatus =
- CheckResult.getByValue(jsonObject["overallStatus"])!;
- result._optical = CheckResult.getByValue(jsonObject["optical"])!;
- result._detailsOptical =
- OpticalStatus.fromJson(jsonObject["detailsOptical"])!;
- result._rfid = CheckResult.getByValue(jsonObject["rfid"])!;
- result._detailsRFID = RFIDStatus.fromJson(jsonObject["detailsRFID"])!;
- result._portrait = CheckResult.getByValue(jsonObject["portrait"])!;
- result._stopList = CheckResult.getByValue(jsonObject["stopList"])!;
-
- return result;
-}
-Summary of all optical results. The same value as OpticalStatus.overallStatus
-CheckResult get optical => _optical;
-Summary of all results.
-CheckResult get overallStatus => _overallStatus;
-Comparison status for portrait in the document aganist live or external image.
-CheckResult get portrait => _portrait;
-Summary of all RFID results. Same as RFIDStatus.overallStatus.
-CheckResult get rfid => _rfid;
-Verification status for document data against database.
-CheckResult get stopList => _stopList;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "overallStatus": overallStatus.value,
- "optical": optical.value,
- "rfid": rfid.value,
- "portrait": portrait.value,
- "stopList": stopList.value,
- "detailsOptical": detailsOptical.toJson(),
- "detailsRFID": detailsRFID.toJson(),
- }.clearNulls();
-Fires when RFID chip reading was interrupted with no severe reasons -(for example connection to the chip was lost) and will be reestablished automatically.
-Only used with default constructor. If RFIDConfig.withoutUI was used, -you will receive this update via DocumentReaderCompletion -and chip reading will not be reestablished.
-error a brief message for developer.
typedef RetryReadChipCompletion = void Function(RFIDException error);
-ScannerConfig
-ScannerConfig.withOnlineProcessingConfig(
- OnlineProcessingConfig onlineProcessingConfig)
- : _scenario = null,
- _onlineProcessingConfig = onlineProcessingConfig;
-ScannerConfig.withScenario(Scenario scenario)
- : _scenario = scenario,
- _onlineProcessingConfig = null;
-Camera id.
-Android only.
-int? cameraId;
-Portrait photo from an external source.
-Requires network connection.
-Uint8List? extPortrait;
-@visibleForTesting
-static ScannerConfig? fromJson(jsonObject) {
- if (jsonObject == null) return null;
-
- var result = ScannerConfig._empty();
-
- result._scenario = Scenario.getByValue(jsonObject["scenario"]);
- result._onlineProcessingConfig =
- OnlineProcessingConfig.fromJson(jsonObject["onlineProcessingConfig"]);
- result.livePortrait = _bytesFromBase64(jsonObject["livePortrait"]);
- result.extPortrait = _bytesFromBase64(jsonObject["extPortrait"]);
- result.cameraId = jsonObject["cameraId"];
-
- return result;
-}
-Live portrait photo.
-Requires network connection.
-Uint8List? livePortrait;
-Configuration class for online processing.
-/// Requires network connection.
-OnlineProcessingConfig? get onlineProcessingConfig => _onlineProcessingConfig;
-Documents processing scenario.
-Scenario? get scenario => _scenario;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "scenario": scenario?.value,
- "onlineProcessingConfig": onlineProcessingConfig?.toJson(),
- "livePortrait": _bytesToBase64(livePortrait),
- "extPortrait": _bytesToBase64(extPortrait),
- "cameraId": cameraId
- }.clearNulls();
-Processing scenario for obtaining MRZ data.
- - -Scenario("Mrz")
- Processing scenario for obtaining barcode data.
- - -Scenario("Barcode")
- Processing scenario for detecting document boundaries.
- - -Scenario("Locate")
- Processing scenario for obtaining visual zone OCR results.
- - -Scenario("Ocr")
- Processing scenario for document type recognition.
- - -Scenario("DocType")
- Processing scenario for obtaining MRZ and/or barcode data.
- - -Scenario("MrzOrBarcode")
- Processing scenario for detecting document boundaries and/or obtaining MRZ data.
- - -Scenario("MrzOrLocate")
- Processing scenario for detecting document boundaries and obtaining MRZ data.
- - -Scenario("MrzAndLocate")
- Processing scenario for detecting document boundaries and obtaining barcode data.
- - -Scenario("BarcodeAndLocate")
- Processing scenario for obtaining MRZ data or visual zone OCR results.
- - -Scenario("MrzOrOcr")
- Processing scenario for obtaining MRZ or barcode or visual zone OCR results.
- - -Scenario("MrzOrBarcodeOrOcr")
- Processing scenario for detecting document boundaries and obtaining -MRZ data or visual zone OCR results.
- - -Scenario("LocateVisual_And_MrzOrOcr")
- Processing scenario for obtaining all document data.
- - -Scenario("FullProcess")
- Processing scenario for obtaining all document data and document authentication.
- - -Scenario("FullAuth")
- Processing scenario for obtaining visual zone OCR results from -Russian National Passport and MRZ data from any document.
- - -Scenario("Id3Rus")
- Processing scenario for obtaining data from registration stamps in -Russian passports.
- - -Scenario("RusStamp")
- Processing scenario for obtaining OCR results of any image.
- - -Scenario("OcrFree")
- Processing scenario for obtaining bank card data.
- - -Scenario("CreditCard")
- Scenario for obtaining an original image without any processing.
- - -Scenario("Capture")
- [MRZ, BARCODE, LOCATE, OCR, DOCTYPE, MRZ_OR_BARCODE, MRZ_OR_LOCATE, MRZ_AND_LOCATE, BARCODE_AND_LOCATE, MRZ_OR_OCR, MRZ_OR_BARCODE_OR_OCR, LOCATE_VISUAL_AND_MRZ_OR_OCR, FULL_PROCESS, FULL_AUTH, ID3RUS…
- const Scenario
-final String value;
-Enumeration contains identifiers that determine the types of elements -for the document authenticity check.
-Will be returned if getByValue if a non-existent was passed.
- - -SecurityFeatureType(-2)
- SecurityFeatureType(-1)
- Blank element.
- - -SecurityFeatureType(0)
- Personalization element.
- - -SecurityFeatureType(1)
- Photo.
- - -SecurityFeatureType(2)
- MRZ.
- - -SecurityFeatureType(3)
- Photo surrounding area.
- - -SecurityFeatureType(4)
- Reserved for internal use.
- - -SecurityFeatureType(5)
- Reserved for internal use.
- - -SecurityFeatureType(6)
- Reserved for internal use.
- - -SecurityFeatureType(7)
- Reserved for internal use.
- - -SecurityFeatureType(8)
- Reserved for internal use.
- - -SecurityFeatureType(9)
- Reserved for internal use.
- - -SecurityFeatureType(10)
- Reserved for internal use.
- - -SecurityFeatureType(11)
- Reserved for internal use.
- - -SecurityFeatureType(12)
- Reserved for internal use.
- - -SecurityFeatureType(13)
- Main portrait and ghost portrait comparison.
- - -SecurityFeatureType(14)
- Main portrait and RFID portrait comparison.
- - -SecurityFeatureType(15)
- Main portrait and other page portrait comparison.
- - -SecurityFeatureType(16)
- Barcode format check.
- - -SecurityFeatureType(17)
- Different lines thickness.
- - -SecurityFeatureType(18)
- Portrait comparison with image from camera.
- - -SecurityFeatureType(19)
- Portrait comparison with image from RFID.
- - -SecurityFeatureType(20)
- Ghost photo.
- - -SecurityFeatureType(21)
- Clear ghost photo.
- - -SecurityFeatureType(22)
- Invisible object.
- - -SecurityFeatureType(23)
- Low contrast object.
- - -SecurityFeatureType(24)
- Photo color type.
- - -SecurityFeatureType(25)
- Photo squareness check.
- - -SecurityFeatureType(26)
- Photo corners shape.
- - -SecurityFeatureType(27)
- SecurityFeatureType(28)
- SecurityFeatureType(28)
- SecurityFeatureType(29)
- SecurityFeatureType(30)
- SecurityFeatureType(31)
- SecurityFeatureType(32)
- SecurityFeatureType(33)
- SecurityFeatureType(34)
- SecurityFeatureType(35)
- SecurityFeatureType(36)
- SecurityFeatureType(38)
- SecurityFeatureType(39)
- Checking the presence of a device that could be used for document capturing.
- - -SecurityFeatureType(40)
- SecurityFeatureType(41)
- SecurityFeatureType(42)
- SecurityFeatureType(43)
- SecurityFeatureType(44)
- SecurityFeatureType(45)
- Visual zone portrait image vs. image from barcode.
- - -SecurityFeatureType(46)
- Image from barcode vs. image from RFID.
- - -SecurityFeatureType(47)
- Image from barcode vs. external source image.
- - -SecurityFeatureType(48)
- Image from barcode vs. photo from camera.
- - -SecurityFeatureType(49)
- Digital signature сheck.
- - -SecurityFeatureType(50)
- Contact сhip check.
- - -SecurityFeatureType(51)
- [UNKNOWN, NONE, BLANK, FILL, PHOTO, MRZ, FALSE_LUMINESCENCE, HOLO_SIMPLE, HOLO_VERIFY_STATIC, HOLO_VERIFY_MULTI_STATIC, HOLO_VERIFY_DINAMIC, PATTERN_NOT_INTERRUPTED, PATTERN_NOT_SHIFTED, PATTERN_SAME_…
- const SecurityFeatureType
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Structure is used to describe the contents of a single document -security object (SO) and the results of its check within the context -of the communication session with electronic document.
-Reference to the source file of the security object data.
-int get fileReference => _fileReference;
-Allows you to deserialize object.
-static SecurityObject? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = SecurityObject();
-
- result._fileReference = jsonObject["fileReference"];
- result._version = jsonObject["version"];
- result._objectType = jsonObject["objectType"];
- result._notifications = jsonObject["notifications"].cast<int>();
- for (var item in jsonObject["signerInfos"])
- result.signerInfos.addSafe(SignerInfo.fromJson(item));
-
- return result;
-}
-The list of remarks occured during the scanning procedure.
-Each element belongs to the LDSParsingErrorCodes.
-List<int> get notifications => _notifications;
-Security object identifier.
-String? get objectType => _objectType;
-List of containers to store information about digital -signature objects contained in the SO.
-List<SignerInfo> get signerInfos => _signerInfos;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "fileReference": fileReference,
- "objectType": objectType,
- "version": version,
- "signerInfos": signerInfos.map((e) => e.toJson()).toList(),
- "notifications": notifications,
- }.clearNulls();
-Security object version.
-int get version => _version;
-Allows you to deserialize object.
-static SecurityObjectCertificates? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = SecurityObjectCertificates();
-
- result._securityObject =
- CertificateData.fromJson(jsonObject["securityObject"]);
-
- return result;
-}
-CertificateData? get securityObject => _securityObject;
-Not identified.
- - -SignManagementAction(0)
- Create PIN.
- - -SignManagementAction(1)
- Change PIN.
- - -SignManagementAction(2)
- Unblock PIN
- - -SignManagementAction(3)
- Terminate PIN.
- - -SignManagementAction(4)
- Generate keys.
- - -SignManagementAction(5)
- Terminate keys.
- - -SignManagementAction(6)
- Sign data.
- - -SignManagementAction(7)
- [UNDEFINED, CREATE_PIN, CHANGE_PIN, UNBLOCK_PIN, TERMINATE_PIN, GENERATE_KEYS, TERMINATE_KEYS, SIGN_DATA]
- const SignManagementAction
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Structure is used to store the result of the verification of a single digital -signature of the number present in EF.SOD.
-Certificate chain, used for the digital signature verification.
-List<CertificateChain> get certificateChain => _certificateChain;
-Data to hash.
-String? get dataToHash => _dataToHash;
-Digital signature hash-function algorithm identifier.
-String? get digestAlgorithm => _digestAlgorithm;
-Allows you to deserialize object.
-static SignerInfo? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = SignerInfo();
-
- result._version = jsonObject["version"];
- result._paStatus = jsonObject["paStatus"];
- result._dataToHash = jsonObject["dataToHash"];
- result._digestAlgorithm = jsonObject["digestAlgorithm"];
- result._signatureAlgorithm = jsonObject["signatureAlgorithm"];
- result._serialNumber = RFIDValue.fromJson(jsonObject["serialNumber"]);
- result._signature = RFIDValue.fromJson(jsonObject["signature"]);
- result._subjectKeyIdentifier =
- RFIDValue.fromJson(jsonObject["subjectKeyIdentifier"]);
- result._issuer = Authority.fromJson(jsonObject["issuer"]);
- result._notifications = jsonObject["notifications"].cast<int>();
- for (var item in jsonObject["signedAttributes"])
- result._signedAttributes.addSafe(Extension.fromJson(item));
- for (var item in jsonObject["certificateChain"])
- result._certificateChain.addSafe(CertificateChain.fromJson(item));
-
- return result;
-}
-Identifier of the necessary certificate issuer.
-Authority? get issuer => _issuer;
-The list of remarks occured during the scanning procedure.
-Each element belongs to the LDSParsingErrorCodes.
-List<int> get notifications => _notifications;
-Result of the digital signature verification.
-int get paStatus => _paStatus;
-Serial number of the necessary certificate.
-RFIDValue? get serialNumber => _serialNumber;
-Binary data of the verified digital signature.
-RFIDValue? get signature => _signature;
-Digital signature algorithm identifier.
-String? get signatureAlgorithm => _signatureAlgorithm;
-Signature object identifier of the necessary certificate.
-RFIDValue? get subjectKeyIdentifier => _subjectKeyIdentifier;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "dataToHash": dataToHash,
- "digestAlgorithm": digestAlgorithm,
- "version": version,
- "paStatus": paStatus,
- "signatureAlgorithm": signatureAlgorithm,
- "issuer": issuer?.toJson(),
- "serialNumber": serialNumber?.toJson(),
- "signature": signature?.toJson(),
- "subjectKeyIdentifier": subjectKeyIdentifier?.toJson(),
- "signedAttributes": signedAttributes.map((e) => e.toJson()).toList(),
- "certificateChain": certificateChain.map((e) => e.toJson()).toList(),
- "notifications": notifications,
- }.clearNulls();
-Version of the digital signature data structure.
-int get version => _version;
-A type specifically made for receiving answer from any function -which does not return anything, but we need to know whether the function -has succeeded or not.
-bool - indicates success status.
-DocReaderException - in case success status is false - brief message for developer,
-null otherwise.
Examples(myFunction returns SuccessOrError):
With error handling:
-var (success, error) = await myFunction();
-if (success) {
- print("success!");
-} else {
- print("Error: ${error!.message}");
-}
-
-Using then:
-myFunction().then((response) {
- var (success, error) = response;
- if (success) {
- print("success!");
- } else {
- print("Error: ${error!.message}");
- }
-});
-
-Without error handling:
-var (success, _) = await myFunction();
-if (success) {
- print("success!");
-}
-
-Most compact:
-if ((await myFunction()).$1) print("success");
-
-typedef SuccessOrError = (bool, DocReaderException?);
-Structure describing single value of the field.
-ASCII code of symbol.
-int get code => _code;
-Allows you to deserialize object.
-static Symbol? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Symbol();
-
- result._code = jsonObject["code"];
- result._rect = Rect.fromJson(jsonObject["rect"]);
- result._probability = jsonObject["probability"];
-
- return result;
-}
-Symbol recognition probability (0–100, %).
-int get probability => _probability;
-Bounds result of the particular value.
-Rect? get rect => _rect;
-String get auxPCD => _auxPCD;
-String get challengePICC => _challengePICC;
-Uint8List get data => _data;
-@visibleForTesting
-static TAChallenge? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = TAChallenge();
-
- result._data = _bytesFromBase64(jsonObject["data"])!;
- result._auxPCD = jsonObject["auxPCD"] ?? "";
- result._challengePICC = jsonObject["challengePICC"] ?? "";
- result._hashPK = jsonObject["hashPK"] ?? "";
- result._idPICC = jsonObject["idPICC"] ?? "";
-
- return result;
-}
-String get hashPK => _hashPK;
-String get idPICC => _idPICC;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "data": _bytesToBase64(data),
- "auxPCD": auxPCD,
- "challengePICC": challengePICC,
- "hashPK": hashPK,
- "idPICC": idPICC,
- }.clearNulls();
-Provided to a user for passing TASignature -to the native part of DocumentReader.
-typedef TASignatureRequest = Future<void> Function(
- ByteData? signature,
-);
-Callback for receiving RFID request data
-typedef TaCertificateCompletion = void Function(
- String? keyCAR,
- PKDCertificateRequest request,
-);
-Callback for receiving RFID request data
-typedef TaSignatureCompletion = void Function(
- TAChallenge? challenge,
- TASignatureRequest request,
-);
-TCC service related parameters for RFID session configuration.
-@visibleForTesting
-static TccParams? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = TccParams();
-
- result.serviceUrlTA = jsonObject["serviceUrlTA"];
- result.serviceUrlPA = jsonObject["serviceUrlPA"];
- result.pfxCertUrl = jsonObject["pfxCertUrl"];
- result.pfxPassPhrase = jsonObject["pfxPassPhrase"];
- result.pfxCert = _dataFromBase64(jsonObject["pfxCert"]);
-
- return result;
-}
-The bytes of the certificate for a TCC service. -This data will be used instead of loading the certificate via pfxCertUrl.
-ByteData? pfxCert;
-The URL for the certificate for a TCC service. -The value of the property must be a valid URL string.
-String? pfxCertUrl;
-The passphrase for the cerficiate provided by the pfxCertUrl property.
-String? pfxPassPhrase;
-The PA URL for the TCC service. The value of the property -must be a valid URL string.
-String? serviceUrlPA;
-The TA URL for the TCC service. The value of the property -must be a valid URL string.
-String? serviceUrlTA;
-@visibleForTesting
-Map<String, dynamic> toJson() => {
- "serviceUrlTA": serviceUrlTA,
- "serviceUrlPA": serviceUrlPA,
- "pfxCertUrl": pfxCertUrl,
- "pfxPassPhrase": pfxPassPhrase,
- "pfxCert": _dataToBase64(pfxCert)
- }.clearNulls();
-Serves for storing information from one text data field.
-List of all comparison statuses for this field type.
-List<Comparison> get comparisonList => _comparisonList;
-Comparison result of the field.
-CheckResult get comparisonStatus => _comparisonStatus;
-Textual field symbolic name.
-String get fieldName => _fieldName;
-Textual field logical type.
-FieldType get fieldType => _fieldType;
-Allows you to deserialize object.
-static TextField? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = TextField();
-
- result._fieldType = FieldType.getByValue(jsonObject["fieldType"])!;
- result._lcid = LCID.getByValue(jsonObject["lcid"])!;
- result._status = CheckResult.getByValue(jsonObject["status"])!;
- result._comparisonStatus =
- CheckResult.getByValue(jsonObject["comparisonStatus"])!;
- result._validityStatus =
- CheckResult.getByValue(jsonObject["validityStatus"])!;
- result._lcidName = jsonObject["lcidName"];
- result._fieldName = jsonObject["fieldName"];
- result._value = jsonObject["value"];
- result._getValue = Value.fromJson(jsonObject["getValue"]);
- for (var item in jsonObject["values"])
- result._values.addSafe(Value.fromJson(item));
- for (var item in jsonObject["comparisonList"])
- result._comparisonList.addSafe(Comparison.fromJson(item));
- for (var item in jsonObject["validityList"])
- result._validityList.addSafe(Validity.fromJson(item));
-
- return result;
-}
-Value? getValue() => _getValue;
-ID of language-culture to differentiate one field of the same type from -another (for example Belarus Passport Page # 31 – Belarusian and Russian -fields of the same type).
-LCID get lcid => _lcid;
-LCID symbolic name.
-String get lcidName => _lcidName;
-Textual field check result.
-CheckResult get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "fieldType": fieldType.value,
- "fieldName": fieldName,
- "lcid": lcid.value,
- "lcidName": lcidName,
- "value": value,
- "getValue": getValue()?.toJson(),
- "values": values.map((e) => e.toJson()).toList(),
- "status": status.value,
- "comparisonList": comparisonList.map((e) => e.toJson()).toList(),
- "validityList": validityList.map((e) => e.toJson()).toList(),
- "comparisonStatus": comparisonStatus.value,
- "validityStatus": validityStatus.value,
- }.clearNulls();
-Validity result of the field
-CheckResult get validityStatus => _validityStatus;
-Value from the field.
-String? get value => _value;
-Structure, containing all text data extracted and recognized from the document.
-List of all available origin source with overall validity -status of all text fields of a particular source type.
-List<TextSource> get availableSourceList => _availableSourceList;
-Comparison status of all text fields.
-CheckResult get comparisonStatus => _comparisonStatus;
-Allows you to deserialize object.
-static TextResult? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = TextResult();
-
- result._status = CheckResult.getByValue(jsonObject["status"])!;
- result._comparisonStatus =
- CheckResult.getByValue(jsonObject["comparisonStatus"])!;
- result._validityStatus =
- CheckResult.getByValue(jsonObject["validityStatus"])!;
- for (var item in jsonObject["availableSourceList"])
- result._availableSourceList.addSafe(TextSource.fromJson(item));
- for (var item in jsonObject["fields"])
- result._fields.addSafe(TextField.fromJson(item));
-
- return result;
-}
-Textual fields check result.
-CheckResult get status => _status;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "status": status.value,
- "comparisonStatus": comparisonStatus.value,
- "validityStatus": validityStatus.value,
- "availableSourceList":
- availableSourceList.map((e) => e.toJson()).toList(),
- "fields": fields.map((e) => e.toJson()).toList(),
- }.clearNulls();
-Validity status of all text fields.
-CheckResult get validityStatus => _validityStatus;
-Structure describing single value of the field.
-Allows you to deserialize object.
-static TextSource? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = TextSource();
-
- result._sourceType = ResultType.getByValue(jsonObject["sourceType"])!;
- result._source = jsonObject["source"];
- result._validityStatus =
- CheckResult.getByValue(jsonObject["validityStatus"])!;
-
- return result;
-}
-The value's origin source string description.
-String? get source => _source;
-The value's origin source.
-ResultType get sourceType => _sourceType;
-Overall validity status of all text fields of this source type.
-CheckResult get validityStatus => _validityStatus;
-Allows you to deserialize object.
-static TransactionInfo? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = TransactionInfo();
-
- result._transactionId = jsonObject["transactionId"];
- result._tag = jsonObject["tag"];
-
- return result;
-}
-String? get tag => _tag;
-String? get transactionId => _transactionId;
-Visible Digital Seal for Non Constrained environments.
-icao.test for Proof of Testing (data defined by CAPSCA),
-icao.vacc for Proof of Vaccination (data defined by WHO).
-Other Types may be added in the future.
- The binary data of the signer certificate.
-BytesData? get certificate => _certificate;
-The certificate chain, used for the digital signature verification.
-List<CertificateChain> get certificateChain => _certificateChain;
-Allows you to deserialize object.
-static VDSNCData? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = VDSNCData();
-
- result._type = jsonObject["type"];
- result._version = jsonObject["version"];
- result._issuingCountry = jsonObject["issuingCountry"];
- result._message = jsonObject["message"];
- result._signatureAlgorithm = jsonObject["signatureAlgorithm"];
- result._signature = BytesData.fromJson(jsonObject["signature"]);
- result._certificate = BytesData.fromJson(jsonObject["certificate"]);
- for (var item in jsonObject["certificateChain"])
- result._certificateChain.addSafe(CertificateChain.fromJson(item));
- result._notifications = jsonObject["notifications"] == null
- ? null
- : List<int>.from(jsonObject["notifications"]);
-
- return result;
-}
-Three letter code identifying the issuing state or organization.
-String? get issuingCountry => _issuingCountry;
-The list of remarks occured during the scanning procedure.
-Each element belongs to the LDSParsingErrorCodes or the LDSParsingNotificationCodes.
-List<int>? get notifications => _notifications;
-The binary data of the verified digital signature.
-BytesData? get signature => _signature;
-The signature algorithm used to produce the signature. ECDSA scheme.
-String? get signatureAlgorithm => _signatureAlgorithm;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "type": type,
- "version": version,
- "issuingCountry": issuingCountry,
- "message": message,
- "signatureAlgorithm": signatureAlgorithm,
- "signature": signature?.toJson(),
- "certificate": certificate?.toJson(),
- "certificateChain": certificateChain.map((e) => e.toJson()).toList(),
- "notifications": notifications,
- }.clearNulls();
-Visible Digital Seal use case type.
-Type is set to icao.test for Proof of Testing (data defined by CAPSCA),
-icao.vacc for Proof of Vaccination (data defined by WHO).
-Other Types may be added in the future.
String? get type => _type;
-Visible Digital Seal use case version.
-int get version => _version;
-Structure describing single value of the field.
-Allows you to deserialize object.
-static Validity? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Validity();
-
- result._sourceType = ResultType.getByValue(jsonObject["sourceType"])!;
- result._status = CheckResult.getByValue(jsonObject["status"])!;
-
- return result;
-}
-The value's origin source.
-ResultType get sourceType => _sourceType;
-Overall validity status of all text fields of this particular field.
-CheckResult get status => _status;
-Structure describing single value of the field.
-A value.
-String? get value => _value;
-Field rectangular area coordinates on the image.
-Rect? get boundRect => _boundRect;
-Allows you to deserialize object.
-static Value? fromJson(jsonObject) {
- if (jsonObject == null) return null;
- var result = Value();
-
- result._pageIndex = jsonObject["pageIndex"];
- result._sourceType = ResultType.getByValue(jsonObject["sourceType"])!;
- result._probability = jsonObject["probability"];
- result._value = jsonObject["value"];
- result._originalValue = jsonObject["originalValue"];
- result._boundRect = Rect.fromJson(jsonObject["boundRect"]);
- for (var item in jsonObject["originalSymbols"])
- result._originalSymbols.addSafe(Symbol.fromJson(item));
- result._rfidOrigin = RFIDOrigin.fromJson(jsonObject["rfidOrigin"]);
-
- return result;
-}
-An original value.
-String? get originalValue => _originalValue;
-An index of the document page whence the textual field is extracted.
-int get pageIndex => _pageIndex;
-Textual field recognition probability (0 - 100, %).
-int get probability => _probability;
-RFID origin data. Only for the 'RFID' source.
-RFIDOrigin? get rfidOrigin => _rfidOrigin;
-Identifies zone whence data is extracted.
-ResultType get sourceType => _sourceType;
-Allows you to serialize object.
-Map<String, dynamic> toJson() => {
- "sourceType": sourceType.value,
- "value": value,
- "originalValue": originalValue,
- "pageIndex": pageIndex,
- "boundRect": boundRect?.toJson(),
- "rfidOrigin": rfidOrigin?.toJson(),
- "originalSymbols": originalSymbols.map((e) => e.toJson()).toList(),
- "probability": probability,
- }.clearNulls();
-Callback that allows user to receive a video file of current session. -Called by DocumentReader when recording process finished.
-filePath The output file URL. Contains URL to recording output for every scanning session.
typedef VideoEncoderCompletion = void Function(
- String filePath,
-);
-Clone of iOS native enum UIViewContentMode
Will be returned if getByValue if a non-existent was passed.
- - -ViewContentMode(-1)
- ViewContentMode(0)
- Contents scaled to fit with fixed aspect. remainder is transparent.
- - -ViewContentMode(1)
- Contents scaled to fill with fixed aspect. some portion of content may be clipped.
- - -ViewContentMode(2)
- redraw on bounds change (calls -setNeedsDisplay).
- - -ViewContentMode(3)
- contents remain same size. positioned adjusted.
- - -ViewContentMode(4)
- ViewContentMode(5)
- ViewContentMode(6)
- ViewContentMode(7)
- ViewContentMode(8)
- ViewContentMode(9)
- ViewContentMode(10)
- ViewContentMode(11)
- ViewContentMode(12)
- [UNKNOWN, SCALE_TO_FILL, SCALE_ASPECT_FIT, SCALE_ASPECT_FILL, REDRAW, CENTER, TOP, BOTTOM, LEFT, RIGHT, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT]
- const ViewContentMode
-final int value;
-A constant List of the values in this enum, in order of their declaration.
-Regula Document Reader SDK
-UIViewContentMode
-Regula Document Reader SDK allows you to read various kinds of identification documents, passports, driving licenses, ID cards, etc. All processing is performed completely offline on your device. No any data leaving your device.
-You can use native camera to scan the documents or image from gallery for extract all data from it.
-This repository contains the source code of the Document Reader API, and the sample application that demonstrates the API calls you can use to interact with the Document Reader library.
-You can find documentation here.
-To obtaining the production license or other purchasing information, please submit an inquiry and our sales team will contact you shortly.
-Please do not hesitate to contact us, if you need any assistance or want to report a bug / suggest an improvement.
-