io.scanbot.sdk.ui.view.nfc.configuration

Class NfcPassportConfiguration

io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration

public class NfcPassportConfiguration

Class which is used to configure class NfcPassportView Contains settings indicating views Behaviour, Texts and Appearance

See Also:

class NfcPassportView

Constructor Detail

NfcPassportConfiguration

public NfcPassportConfiguration()

Class which is used to configure class NfcPassportView Contains settings indicating views Behaviour, Texts and Appearance

See Also:

class NfcPassportView

Method Detail

getNfcPassportConfiguration

@NotNull
public java.util.Map<java.lang.String,java.io.Serializable> getNfcPassportConfiguration()

setFlashEnabled

public void setFlashEnabled(boolean flashEnabled)

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

setOrientationLockMode

public void setOrientationLockMode(@NotNull
                                   io.scanbot.sdk.ui.view.base.configuration.CameraOrientationMode cameraOrientationMode)

Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.

setCameraModule

public void setCameraModule(@NotNull
                            io.scanbot.sdk.camera.CameraModule cameraModule)

Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.

setSuccessBeepEnabled

public void setSuccessBeepEnabled(boolean successBeepEnabled)

Controls whether to play a beep sound after a successful detection. Default value is TRUE.

setTopBarBackgroundColor

public void setTopBarBackgroundColor(int topBarBackgroundColor)

Background color of the top toolbar.

setTopBarButtonsColor

public void setTopBarButtonsColor(int topBarButtonsColor)

Color of the titles of all buttons in the top toolbar.

setTopBarButtonsInactiveColor

public void setTopBarButtonsInactiveColor(int topBarButtonsInactiveColor)

Color of the titles of all buttons in the top toolbar.

setCameraOverlayColor

public void setCameraOverlayColor(int cameraOverlayColor)

Background color outside of the finder window.

setFinderLineWidth

public void setFinderLineWidth(int finderLineWidth)

Thickness of the finder window's outline.

setFinderLineColor

public void setFinderLineColor(int finderLineColor)

Color of the finder window's outline.

setFinderTextHintColor

public void setFinderTextHintColor(int finderTextHintColor)

Color of the text hint under the finder window.

setCancelButtonTitle

public void setCancelButtonTitle(@NotNull
                                 java.lang.String cancelButtonTitle)

Title of the cancel button.

setFinderTextHint

public void setFinderTextHint(@NotNull
                              java.lang.String finderTextHint)

Text hint shown under the finder window.

setEnableCameraExplanationText

public void setEnableCameraExplanationText(@NotNull
                                           java.lang.String enableCameraExplanationText)

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.

setEnableCameraButtonTitle

public void setEnableCameraButtonTitle(@NotNull
                                       java.lang.String enableCameraButtonTitle)

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

setScanPassportTitle

public void setScanPassportTitle(@NotNull
                                 java.lang.String title)

A title for the screen of passport scanning.

setHoldOverTheChipTitle

public void setHoldOverTheChipTitle(@NotNull
                                    java.lang.String title)

A title for the state when the user should start scanning data from the NFC chip

setDownloadingDataTitle

public void setDownloadingDataTitle(@NotNull
                                    java.lang.String title)

A title for the state when the data is loading from the NFC chip

setDownloadErrorTitle

public void setDownloadErrorTitle(@NotNull
                                  java.lang.String title)

A title for the state when the error happened during the data loading from the NFC chip

setAuthenticationErrorTitle

public void setAuthenticationErrorTitle(@NotNull
                                        java.lang.String title)

A title for the state when the error happened during the data loading from the NFC chip because of the wrong MRZ data, so the data cannot be processed

setNoChipErrorTitle

public void setNoChipErrorTitle(@NotNull
                                java.lang.String title)

A title for the state when there is no hardware for NFC scanning installed on the device

setChipDisabledErrorTitle

public void setChipDisabledErrorTitle(@NotNull
                                      java.lang.String title)

A title for the state when the NFC chip is disabled on the device

setRetryButtonTitle

public void setRetryButtonTitle(@NotNull
                                java.lang.String title)

A title for the retry button

setProgressBarColor

public void setProgressBarColor(int color)

The color of progress bar during NFC scanning

setUseButtonsAllCaps

public void setUseButtonsAllCaps(boolean allCaps)

Controls whether buttons should use all capitals style

setShouldSavePhotoImageInStorage

public void setShouldSavePhotoImageInStorage(boolean shouldSave)

Defines, if photo image should be stored in internal storage on disk.

setPassportPhotoSaveCallback

public void setPassportPhotoSaveCallback(@NotNull
                                         java.lang.Class<? extends io.scanbot.sdk.ui.view.nfc.PassportPhotoSaveCallback> clazz)

Define the Class for callback that will be called when photo is retrieved from NFC tag.

Can be used e.g. for saving it in a secure manner.

See Also:

Class