Interface HealthInsuranceCardScannerConfiguration

interface HealthInsuranceCardScannerConfiguration {
    cameraModule?: CameraModule;
    cameraOverlayColor?: string;
    cameraPreviewMode?: CameraPreviewMode;
    cancelButtonHidden?: boolean;
    cancelButtonTitle?: string;
    detectionStatusFailedDetectionText?: string;
    detectionStatusFailedValidationText?: string;
    detectionStatusSuccessText?: string;
    enableCameraButtonTitle?: string;
    enableCameraExplanationText?: string;
    finderLineColor?: string;
    finderLineWidth?: number;
    finderTextHint?: string;
    finderTextHintColor?: string;
    flashButtonHidden?: boolean;
    flashButtonTitle?: string;
    flashEnabled?: boolean;
    orientationLockMode?: OrientationLockMode;
    replaceCancelButtonWithIcon?: boolean;
    topBarBackgroundColor?: string;
    topBarButtonsActiveColor?: string;
    topBarButtonsInactiveColor?: string;
    touchToFocusEnabled?: boolean;
    useButtonsAllCaps?: boolean;
}

Properties

cameraModule? cameraOverlayColor? cameraPreviewMode? cancelButtonHidden? cancelButtonTitle? detectionStatusFailedDetectionText? detectionStatusFailedValidationText? detectionStatusSuccessText? enableCameraButtonTitle? enableCameraExplanationText? finderLineColor? finderLineWidth? finderTextHint? finderTextHintColor? flashButtonHidden? flashButtonTitle? flashEnabled? orientationLockMode? replaceCancelButtonWithIcon? topBarBackgroundColor? topBarButtonsActiveColor? topBarButtonsInactiveColor? touchToFocusEnabled? useButtonsAllCaps?

Properties

Optional cameraModule

cameraModule?: CameraModule

The preferred camera module (default - BACK)

Optional cameraOverlayColor

cameraOverlayColor?: string

Background color outside of the finder window.

Optional cameraPreviewMode

cameraPreviewMode?: CameraPreviewMode

Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only

Optional cancelButtonHidden

cancelButtonHidden?: boolean

Whether the cancel button is hidden or not. iOS only.

Optional cancelButtonTitle

cancelButtonTitle?: string

Title of the cancel button.

Optional detectionStatusFailedDetectionText

detectionStatusFailedDetectionText?: string

String being displayed when health insurance card was not found.

Optional detectionStatusFailedValidationText

detectionStatusFailedValidationText?: string

String being displayed when health insurance card was found but not recognized.

Optional detectionStatusSuccessText

detectionStatusSuccessText?: string

String being displayed when health insurance card was found and recognized.

Optional enableCameraButtonTitle

enableCameraButtonTitle?: string

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

Optional enableCameraExplanationText

enableCameraExplanationText?: string

Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.

Optional finderLineColor

finderLineColor?: string

Foreground color of the detection overlay.

Optional finderLineWidth

finderLineWidth?: number

Width of finder frame border. Default is 2.

Optional finderTextHint

finderTextHint?: string

String being displayed as description.

Optional finderTextHintColor

finderTextHintColor?: string

Foreground color of the description label.

Optional flashButtonHidden

flashButtonHidden?: boolean

Controls whether the flash toggle button is hidden or not. iOS only.

Optional flashButtonTitle

flashButtonTitle?: string

Title of the flash toggle button. iOS only.

Optional flashEnabled

flashEnabled?: boolean

Controls whether the flash should be initially enabled. The default value is FALSE.

Optional orientationLockMode

orientationLockMode?: OrientationLockMode

UI Interface orientation lock mode

Optional replaceCancelButtonWithIcon

replaceCancelButtonWithIcon?: boolean

If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.

Optional topBarBackgroundColor

topBarBackgroundColor?: string

The background color of the top toolbar.

Optional topBarButtonsActiveColor

topBarButtonsActiveColor?: string

The color of all active toggle buttons in the toolbar.

Optional topBarButtonsInactiveColor

topBarButtonsInactiveColor?: string

The color of all inactive toggle buttons in the toolbar.

Optional touchToFocusEnabled

touchToFocusEnabled?: boolean

Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

Optional useButtonsAllCaps

useButtonsAllCaps?: boolean

Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.

Settings

Member Visibility

Theme

On This Page

cameraModulecameraOverlayColorcameraPreviewModecancelButtonHiddencancelButtonTitledetectionStatusFailedDetectionTextdetectionStatusFailedValidationTextdetectionStatusSuccessTextenableCameraButtonTitleenableCameraExplanationTextfinderLineColorfinderLineWidthfinderTextHintfinderTextHintColorflashButtonHiddenflashButtonTitleflashEnabledorientationLockModereplaceCancelButtonWithIcontopBarBackgroundColortopBarButtonsActiveColortopBarButtonsInactiveColortouchToFocusEnableduseButtonsAllCaps