Skip navigation links
A B C D E F G H I L M N O P R S T U 

A

applyConfiguration(mrzCameraPresenter, nfcPassportPresenter, mrzCameraView, nfcPassportView, context) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportConfigHelper
 

B

back() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
 
backPressed() - Method in interface io.scanbot.sdk.ui.view.nfc.INfcPassportView.Listener
User pressed on the back arrow
backPressed() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
User pressed on the back arrow
BaseNfcPassportActivity - Class in io.scanbot.sdk.ui.view.nfc
Represents a screen of passport scanning with NFC and MRZ
BaseNfcPassportActivity() - Constructor for class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
Represents a screen of passport scanning with NFC and MRZ
BaseNfcPassportActivity.Companion - Class in io.scanbot.sdk.ui.view.nfc
 
BaseNfcPassportFragment - Class in io.scanbot.sdk.ui.view.nfc
Represents a screen of passport scanning with NFC and MRZ
BaseNfcPassportFragment() - Constructor for class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
Represents a screen of passport scanning with NFC and MRZ
BaseNfcPassportFragment.Companion - Class in io.scanbot.sdk.ui.view.nfc
 

C

checkCameraPermissionUseCase - Variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
checkNfcState() - Method in class io.scanbot.sdk.ui.view.nfc.interactor.CheckNfcStateUseCase
 
CheckNfcStateUseCase - Class in io.scanbot.sdk.ui.view.nfc.interactor
Allows to detect the current state of the NFC chip of the device
CheckNfcStateUseCase(context) - Constructor for class io.scanbot.sdk.ui.view.nfc.interactor.CheckNfcStateUseCase
Allows to detect the current state of the NFC chip of the device
Companion - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
Companion - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
Companion - Static variable in interface io.scanbot.sdk.ui.view.nfc.INfcPassportView.Listener
 
Companion - Static variable in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
Companion - Static variable in class io.scanbot.sdk.ui.view.nfc.interactor.SaveNfcPassportImageUseCase
 
Companion - Static variable in class io.scanbot.sdk.ui.view.nfc.NfcPassportNavigator
 
Companion - Static variable in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
component1() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component10() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component10() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component10() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component11() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component11() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component11() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component12() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component12() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component12() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component13() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component13() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component14() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component14() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component15() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component15() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component16() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component17() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component18() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component19() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component2() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component2() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component2() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
component2() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
component2() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component20() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component21() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component3() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component3() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component3() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
component3() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
component3() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component4() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component4() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component4() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component5() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component5() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component5() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component6() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component6() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component6() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component7() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component7() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component7() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component8() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component8() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component8() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
component9() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
component9() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
component9() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
Configuration(scanPassportTitle, downloadDataTitle, downloadingDataTitle, downloadErrorTitle, authErrorTitle, noChipErrorTitle, chipDisabledErrorTitle, retryButtonTitle, toolbarColor, toolbarButtonColor, progressBarColor, isButtonsAllCaps) - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
Configuration for class NfcPassportView
Configuration.Companion - Class in io.scanbot.sdk.ui.view.nfc
 
copy(documentType, issuingStateOrOrganization, documentNumber, checkDigitDocNumber, optionalData, optionalData2, dateOfBirth6Digit, checkDigitDateOfBirth, sex, dateOfExpiry, checkDigitExpiryDate, nationality, checkDigitComposite, nameOfDocumentHolder, checkDigitOptionalData) - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
copy(numberOfImages, version, lengthOfRecord, numberOfFacialImages, facialRecordDataLength, numberOfFeaturePoints, gender, eyeColor, hairColor, featureMask, expression, poseAngle, poseAngleUncertainty, faceImageType, imageDataType, imageWidth, imageHeight, imageColorspace, sourceType, deviceType, quality) - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
copy(dg1Group, dg2Group, photo) - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
Base class for the result of the passport scanning
copy(step, nfcKey, nfcState) - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
copy(mrzRecognitionResult) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
copy(nfcPassportData) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
copy(scanPassportTitle, downloadDataTitle, downloadingDataTitle, downloadErrorTitle, authErrorTitle, noChipErrorTitle, chipDisabledErrorTitle, retryButtonTitle, toolbarColor, toolbarButtonColor, progressBarColor, isButtonsAllCaps) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
Configuration for class NfcPassportView
createFragment(configuration) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
CUSTOM_CONFIGURATION - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
CUSTOM_CONFIGURATION - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 

D

Dg1ScanningResult - Class in io.scanbot.sdk.ui.view.nfc.entity
 
Dg1ScanningResult(documentType, issuingStateOrOrganization, documentNumber, checkDigitDocNumber, optionalData, optionalData2, dateOfBirth6Digit, checkDigitDateOfBirth, sex, dateOfExpiry, checkDigitExpiryDate, nationality, checkDigitComposite, nameOfDocumentHolder, checkDigitOptionalData) - Constructor for class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
Dg2ScanningResult - Class in io.scanbot.sdk.ui.view.nfc.entity
 
Dg2ScanningResult(numberOfImages, version, lengthOfRecord, numberOfFacialImages, facialRecordDataLength, numberOfFeaturePoints, gender, eyeColor, hairColor, featureMask, expression, poseAngle, poseAngleUncertainty, faceImageType, imageDataType, imageWidth, imageHeight, imageColorspace, sourceType, deviceType, quality) - Constructor for class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 

E

equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
equals(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
extract(tag, key) - Method in class io.scanbot.sdk.ui.view.nfc.interactor.ProcessNfcTagUseCase
Extracts the passport data from the given nfc tag with a given key
EXTRACTED_FIELDS_EXTRA - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 

F

finishWithResult(passportNfcData) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
Delivers scanned passport content to the user

G

getAuthErrorTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getCheckCameraPermissionUseCase() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getCheckDigitComposite() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getCheckDigitDateOfBirth() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getCheckDigitDocNumber() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getCheckDigitExpiryDate() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getCheckDigitOptionalData() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getChipDisabledErrorTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getConfigHelper() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getConfiguration() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView
 
getDateOfBirth6Digit() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getDateOfExpiry() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getDEFAULT() - Method in class io.scanbot.sdk.ui.view.nfc.State.Companion
Default state.
getDeviceType() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getDg1Group() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
getDg2Group() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
getDocumentNumber() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getDocumentType() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getDownloadDataTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getDownloadErrorTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getDownloadingDataTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getExpression() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getEyeColor() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getFaceImageType() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getFacialRecordDataLength() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getFeatureMask() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getGender() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getHairColor() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getImageColorspace() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getImageDataType() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getImageHeight() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getImageWidth() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getIssuingStateOrOrganization() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getKey() - Method in enum io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfigurationParams
 
getLayoutRes() - Method in class io.scanbot.sdk.ui.view.nfc.MRZNfcCameraView
 
getLengthOfRecord() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getMrzCameraPresenter() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getMrzCameraView() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getMrzRecognitionResult() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
getMrzScanner() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getNameOfDocumentHolder() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getNationality() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getNavigator() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getNfcKey() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
getNfcPassportConfiguration() - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
 
getNfcPassportData() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
getNfcPassportPresenter() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getNfcPassportView() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
getNfcState() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
getNoChipErrorTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getNULL() - Method in class io.scanbot.sdk.ui.view.nfc.Listener.Companion
Null-object pattern.
getNumberOfFacialImages() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getNumberOfFeaturePoints() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getNumberOfImages() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getOptionalData() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getOptionalData2() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getPassportPhotoSaveCallbackClass() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportConfigHelper
Retrieve possibly set photo saving callback Class from configuration
getPhoto() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
getPlaySuccessBeep() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportConfigHelper
 
getPoseAngle() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getPoseAngleUncertainty() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getProgressBarColor() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getQuality() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getRetryButtonTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getScanPassportTitle() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getSex() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
getSourceType() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
getStep() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
getToolbarButtonColor() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getToolbarColor() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
getType() - Method in exception io.scanbot.sdk.ui.view.nfc.interactor.NfcPassportException
type of the error
getVersion() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 

H

hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
hashCode() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 

I

INfcPassportView - Interface in io.scanbot.sdk.ui.view.nfc
Represents screen for passport scanning with NFC and MRZ
INfcPassportView.Listener - Interface in io.scanbot.sdk.ui.view.nfc
Notified about user interactions.
INfcPassportView.NfcScanStep - Enum in io.scanbot.sdk.ui.view.nfc
Indicates the current step of the Passport scanning
INfcPassportView.State - Class in io.scanbot.sdk.ui.view.nfc
io.scanbot.sdk.ui.view.nfc - package io.scanbot.sdk.ui.view.nfc
 
io.scanbot.sdk.ui.view.nfc.configuration - package io.scanbot.sdk.ui.view.nfc.configuration
 
io.scanbot.sdk.ui.view.nfc.entity - package io.scanbot.sdk.ui.view.nfc.entity
 
io.scanbot.sdk.ui.view.nfc.interactor - package io.scanbot.sdk.ui.view.nfc.interactor
 
isButtonsAllCaps() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 

L

Listener.Companion - Class in io.scanbot.sdk.ui.view.nfc
 

M

mrzCameraPresenter - Variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
mrzCameraView - Variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
MRZNfcCameraView - Class in io.scanbot.sdk.ui.view.nfc
 
MRZNfcCameraView(context, attrs) - Constructor for class io.scanbot.sdk.ui.view.nfc.MRZNfcCameraView
 
mrzProcessed() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
Allow to handle when the new mrz detectino result was processed
mrzProcessed() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
Indicates to user that the new mrz result was processed
MrzProcessed(mrzRecognitionResult) - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
mrzScanner - Variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 

N

NfcPassportConfigHelper - Class in io.scanbot.sdk.ui.view.nfc
Helper to handle the configuration for passport scanning
NfcPassportConfigHelper() - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportConfigHelper
Helper to handle the configuration for passport scanning
NfcPassportConfiguration - Class in io.scanbot.sdk.ui.view.nfc.configuration
Class which is used to configure class NfcPassportView Contains settings indicating views Behaviour, Texts and Appearance
NfcPassportConfiguration() - Constructor for class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Class which is used to configure class NfcPassportView Contains settings indicating views Behaviour, Texts and Appearance
NfcPassportConfigurationParams - Enum in io.scanbot.sdk.ui.view.nfc.configuration
Class containing all the keys which are used to configure the screen for scanning passport with MRZ and NFC scanners
NfcPassportException - Exception in io.scanbot.sdk.ui.view.nfc.interactor
Exception that wraps the error during the nfc data scanning from passport
NfcPassportException(type) - Constructor for exception io.scanbot.sdk.ui.view.nfc.interactor.NfcPassportException
Exception that wraps the error during the nfc data scanning from passport
NfcPassportNavigator - Class in io.scanbot.sdk.ui.view.nfc
Navigator for passport scanning
NfcPassportNavigator() - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportNavigator
Navigator for passport scanning
NfcPassportNavigator.Companion - Class in io.scanbot.sdk.ui.view.nfc
 
nfcPassportPresenter - Variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
NfcPassportPresenter - Class in io.scanbot.sdk.ui.view.nfc
Presenter for class NfcPassportView
NfcPassportPresenter(navigator, backgroundTaskScheduler, checkNfcStateUseCase, processNfcTagUseCase, saveNfcPassportImageUseCase, passportPhotoSaveCallback, mrzScanningSession) - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
Presenter for class NfcPassportView
NfcPassportPresenter.MrzProcessed - Class in io.scanbot.sdk.ui.view.nfc
 
NfcPassportPresenter.NfcScanned - Class in io.scanbot.sdk.ui.view.nfc
 
NfcPassportScanningResult - Class in io.scanbot.sdk.ui.view.nfc.entity
Base class for the result of the passport scanning
NfcPassportScanningResult(dg1Group, dg2Group, photo) - Constructor for class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
Base class for the result of the passport scanning
nfcPassportView - Variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
NfcPassportView - Class in io.scanbot.sdk.ui.view.nfc
Represents a view for navigating through the process of NFC Scanning during passport scan.
NfcPassportView(context, attrs) - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportView
Represents a view for navigating through the process of NFC Scanning during passport scan.
NfcPassportView.Configuration - Class in io.scanbot.sdk.ui.view.nfc
Configuration for class NfcPassportView
NfcScanned(nfcPassportData) - Constructor for class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
NfcState - Enum in io.scanbot.sdk.ui.view.nfc.interactor
State of the NFC chip of the device

O

onBackPressed() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
onBackPressed() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
Processing back press
onCancelScanning() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
User wants to cancel scanning
onCancelScanningLicenseInvalid() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
Scanning is canceled because of the invalid license
onCreate(savedInstanceState) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
onCreate(savedInstanceState) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
onCreateView(inflater, container, savedInstanceState) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView
 
onImageRetrieved(photo) - Method in interface io.scanbot.sdk.ui.view.nfc.PassportPhotoSaveCallback
Method called when NFC tag scanned, passing obtained photo or null
onNewIntent(intent) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
onPause() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
onRequestPermissionsResult(requestCode, permissions, grantResults) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
onResume() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
onStart() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
onStop() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 

P

PACKAGE_SCHEME - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
PassportPhotoSaveCallback - Interface in io.scanbot.sdk.ui.view.nfc
Interface of callback for processing photo, obtained from passport's NFC tag
pause() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
 
PERMISSIONS_REQUEST_CAMERA - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
PHOTO_FILE_NAME - Static variable in class io.scanbot.sdk.ui.view.nfc.interactor.SaveNfcPassportImageUseCase
 
prepareDefault(context) - Method in class io.scanbot.sdk.ui.view.nfc.Configuration.Companion
 
processNfcTag(tag) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
Process the NFC tag callback from the system
processNfcTag(tag) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
Extracts data from the nfc tag if it is needed
ProcessNfcTagUseCase - Class in io.scanbot.sdk.ui.view.nfc.interactor
Connects to the given nfc tag and extracts data with a given key
ProcessNfcTagUseCase(passportNfcScanner) - Constructor for class io.scanbot.sdk.ui.view.nfc.interactor.ProcessNfcTagUseCase
Connects to the given nfc tag and extracts data with a given key

R

requestCameraPermission() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
User want to request camera permission
requestCameraPermission() - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
RESULT_LICENSE_INVALID - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportActivity
 
resume(view) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
 
retryClicked() - Method in interface io.scanbot.sdk.ui.view.nfc.INfcPassportView.Listener
User press on the retry button
retryClicked() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
User press on the retry button

S

saveNfcPassportImage(bitmap) - Method in class io.scanbot.sdk.ui.view.nfc.interactor.SaveNfcPassportImageUseCase
Stores the given fields in NfcPassportFileStorage
SaveNfcPassportImageUseCase - Class in io.scanbot.sdk.ui.view.nfc.interactor
Saves photo image of passport from the Nfc tag in the files repository
SaveNfcPassportImageUseCase(nfcPassportFileStorage, imageFileIOProcessor) - Constructor for class io.scanbot.sdk.ui.view.nfc.interactor.SaveNfcPassportImageUseCase
Saves photo image of passport from the Nfc tag in the files repository
SaveNfcPassportImageUseCase.Companion - Class in io.scanbot.sdk.ui.view.nfc.interactor
 
setAuthenticationErrorTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
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
setAuthErrorTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setButtonsAllCaps(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setCameraModule(cameraModule) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Set supported camera module: CameraModule.BACK, CameraModule.FRONT or others. Optional. By default is CameraModule.BACK.
setCameraOverlayColor(cameraOverlayColor) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Background color outside of the finder window.
setCancelButtonTitle(cancelButtonTitle) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Title of the cancel button.
setCheckCameraPermissionUseCase(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setChipDisabledErrorTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the state when the NFC chip is disabled on the device
setChipDisabledErrorTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setConfigHelper(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setConfiguration(map) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportConfigHelper
 
setDownloadDataTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setDownloadErrorTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the state when the error happened during the data loading from the NFC chip
setDownloadErrorTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setDownloadingDataTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the state when the data is loading from the NFC chip
setDownloadingDataTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setEnableCameraButtonTitle(enableCameraButtonTitle) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
setEnableCameraExplanationText(enableCameraExplanationText) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
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.
setFinderLineColor(finderLineColor) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Color of the finder window's outline.
setFinderLineWidth(finderLineWidth) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Thickness of the finder window's outline.
setFinderTextHint(finderTextHint) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Text hint shown under the finder window.
setFinderTextHintColor(finderTextHintColor) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Color of the text hint under the finder window.
setFlashEnabled(flashEnabled) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Controls whether the flash should be initially enabled. The default value is FALSE.
setHoldOverTheChipTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the state when the user should start scanning data from the NFC chip
setListener(listener) - Method in interface io.scanbot.sdk.ui.view.nfc.INfcPassportView
 
setListener(listener) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView
 
setMrzCameraPresenter(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setMrzCameraView(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setMrzScanner(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setNfcPassportPresenter(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setNfcPassportView(p) - Method in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
setNoChipErrorTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the state when there is no hardware for NFC scanning installed on the device
setNoChipErrorTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setOrientationLockMode(cameraOrientationMode) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. By default the camera orientation is not locked.
setPassportPhotoSaveCallback(clazz) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Define the Class for callback that will be called when photo is retrieved from NFC tag.
setPlaySuccessBeep(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportConfigHelper
 
setProgressBarColor(color) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
The color of progress bar during NFC scanning
setProgressBarColor(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setRetryButtonTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the retry button
setRetryButtonTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setSavePhotoImageAllowed(allowed) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter
Enables/Disables saving of the photo image in sdk storage
setScanPassportTitle(title) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
A title for the screen of passport scanning.
setScanPassportTitle(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setShouldSavePhotoImageInStorage(shouldSave) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Defines, if photo image should be stored in internal storage on disk.
setSuccessBeepEnabled(successBeepEnabled) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Controls whether to play a beep sound after a successful detection. Default value is TRUE.
setToolbarButtonColor(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setToolbarColor(p) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 
setTopBarBackgroundColor(topBarBackgroundColor) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Background color of the top toolbar.
setTopBarButtonsColor(topBarButtonsColor) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Color of the titles of all buttons in the top toolbar.
setTopBarButtonsInactiveColor(topBarButtonsInactiveColor) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Color of the titles of all buttons in the top toolbar.
setUseButtonsAllCaps(allCaps) - Method in class io.scanbot.sdk.ui.view.nfc.configuration.NfcPassportConfiguration
Controls whether buttons should use all capitals style
State(step, nfcKey, nfcState) - Constructor for class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
State() - Constructor for class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
State.Companion - Class in io.scanbot.sdk.ui.view.nfc
 

T

TAG - Static variable in class io.scanbot.sdk.ui.view.nfc.BaseNfcPassportFragment
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg1ScanningResult
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.entity.Dg2ScanningResult
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.entity.NfcPassportScanningResult
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.INfcPassportView.State
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.MrzProcessed
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportPresenter.NfcScanned
 
toString() - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView.Configuration
 

U

updateCameraPermissionView(cameraPermissionGranted) - Method in class io.scanbot.sdk.ui.view.nfc.MRZNfcCameraView
 
updateState(newState) - Method in class io.scanbot.sdk.ui.view.nfc.NfcPassportView
 
A B C D E F G H I L M N O P R S T U 
Skip navigation links