performScan method

  1. @override
Future<BlinkIdScanningResult?> performScan(
  1. BlinkIdSdkSettings blinkidSdkSettings,
  2. BlinkIdSessionSettings blinkidSessionSettings, [
  3. BlinkIdScanningUxSettings? blinkIdScanningUxSettings,
  4. ClassFilter? classFilter,
])
override

The performScan platform channel method launches the BlinkID scanning process with the default UX properties. It takes the following parameters: BlinkIdSdkSettings, BlinkIdSessionSettings and the optional ClassFilter class.

  1. BlinkID SDK Settings - BlinkIdSdkSettings: the class that contains all of the available SDK settings. It contains settings for the license key, and how the models, that the SDK needs for the scanning process, should be obtained. To obtain a valid license key, please visit https://developer.microblink.com/ or contact us directly at https://help.microblink.com

  2. BlinkID Session Settings - BlinkIdSessionSettings: the class that contains various settings for the scanning session. It contains the settings for the ScanningMode and BlinkIdScanningSettings, which define various parameters that control the scanning process.

  3. The optional BlinkID scanning UX settings class - BlinkIdScanningUxSettings - the class that allows customization of various aspects of the UI & UX used during the scanning process.

  4. The optional ClassFilter class - ClassFilter: the class which controls which documents will be accepted or reject for information extraction during the scanning session. See ClassFilter for more implementation information.

Implementation

@override
Future<BlinkIdScanningResult?> performScan(
  BlinkIdSdkSettings blinkidSdkSettings,
  BlinkIdSessionSettings blinkidSessionSettings, [
  BlinkIdScanningUxSettings? blinkIdScanningUxSettings,
  ClassFilter? classFilter,
]) async {
  final jsonBlinkIdResult = await methodChannel
      .invokeMethod(ARG_SCAN_METHOD, {
        ARG_BLINKID_SDK_SETTINGS: jsonDecode(jsonEncode(blinkidSdkSettings)),
        ARG_SESSION_SETTINGS: jsonDecode(jsonEncode(blinkidSessionSettings)),
        ARG_UX_SETTINGS: jsonDecode(jsonEncode(blinkIdScanningUxSettings)),
        ARG_CLASS_FILTER: jsonDecode(jsonEncode(classFilter)),
      });

  final decodedMap = Map<String, dynamic>.from(jsonDecode(jsonBlinkIdResult));
  return BlinkIdScanningResult(decodedMap);
}