IDentity-SDK/com.idmission.sdk2.client.model/SDKCustomizationOptions

SDKCustomizationOptions

public final class SDKCustomizationOptions implements Parcelable

Parameters

language

This field set application default language.

bothCameraToggle

Boolean value to enable camera toggle button in both selfie and document camera

documentCameraToggle

Boolean value to enable camera toggle button in document camera view.

liveFaceCameraToggle

Boolean value to enable camera toggle button in Selfie camera view.

defaultLiveFaceCamera

Valid values are: - FRONT and BACK : to set camera default facing in Selfie Camera view.

defaultDocumentCamera

Valid values are: - FRONT and BACK : to set camera default.

geolocationRequired

Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is false.

Constructors

SDKCustomizationOptions

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera, CameraFacing defaultDocumentCamera, CameraOrientation documentCameraOrientation, Boolean isDebugMode, Boolean isScreenRecordingEnabled, SelfieCaptureCustomizationOptions selfieCaptureCustomizationOptions, IDCaptureCustomizationOptions idCaptureCustomizationOptions, DocumentCaptureCustomizationOptions documentCaptureCustomizationOptions, SignatureCaptureCustomizationOptions signatureCaptureCustomizationOptions, VideoIdCaptureCustomizationOptions videoIdCaptureCustomizationOptions, VoiceCaptureCustomizationOptions voiceCaptureCustomizationOptions, AutoFillCaptureCustomizationOptions autoFillCaptureCustomizationOptions, Boolean geolocationRequired)

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera)

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle)

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle)

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle)

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language)

@JvmOverloads()

public SDKCustomizationOptions SDKCustomizationOptions()

Properties

autoFillCaptureCustomizationOptions

private AutoFillCaptureCustomizationOptions autoFillCaptureCustomizationOptions

Option to customize AutoFill Capture screens.

bothCameraToggle

private Boolean bothCameraToggle

Type: Boolean
nullable: false
example: false

defaultDocumentCamera

private CameraFacing defaultDocumentCamera

Type: CameraFacing
nullable: false
example: CameraFacing.BACK

defaultLiveFaceCamera

private CameraFacing defaultLiveFaceCamera

Type: CameraFacing
nullable: false
example: CameraFacing.FRONT

documentCameraOrientation

private CameraOrientation documentCameraOrientation

Type: CameraOrientation
nullable: false
example: CameraOrientation.PORTRAIT

documentCameraToggle

private Boolean documentCameraToggle

Type: Boolean
nullable: false
example: false

documentCaptureCustomizationOptions

private DocumentCaptureCustomizationOptions documentCaptureCustomizationOptions

Option to customize Document Capture and Instruction screens.

geolocationRequired

private Boolean geolocationRequired

Option to indicate whether users should be blocked from proceeding if they block location access.

idCaptureCustomizationOptions

private IDCaptureCustomizationOptions idCaptureCustomizationOptions

Option to customize ID Capture, Retry and Instruction screens.

isDebugMode

private Boolean isDebugMode

Option to set Debug mode. Whether or not to display debug information during capture. Default is false.

isScreenRecordingEnabled

private Boolean isScreenRecordingEnabled

Option to enable video recording and screenshots. Default is false.

language

private LANGUAGE language

Type: LANGUAGE
nullable: true
example:

 LANGUAGE.valueOf(EN)

liveFaceCameraToggle

private Boolean liveFaceCameraToggle

Type: Boolean
nullable: false
example: false

selfieCaptureCustomizationOptions

private SelfieCaptureCustomizationOptions selfieCaptureCustomizationOptions

Option to customize Selfie Capture, Retry and Instruction screens.

signatureCaptureCustomizationOptions

private SignatureCaptureCustomizationOptions signatureCaptureCustomizationOptions

Option to customize Signature Capture and Instruction screens.

videoIdCaptureCustomizationOptions

private VideoIdCaptureCustomizationOptions videoIdCaptureCustomizationOptions

Option to customize Video ID Capture screens.

voiceCaptureCustomizationOptions

private VoiceCaptureCustomizationOptions voiceCaptureCustomizationOptions

Option to customize Voice Capture screens.

Functions

describeContents

public abstract Integer describeContents()

getAutoFillCaptureCustomizationOptions

public final AutoFillCaptureCustomizationOptions getAutoFillCaptureCustomizationOptions()

Option to customize AutoFill Capture screens.

getBothCameraToggle

public final Boolean getBothCameraToggle()

Type: Boolean
nullable: false
example: false

getDefaultDocumentCamera

public final CameraFacing getDefaultDocumentCamera()

Type: CameraFacing
nullable: false
example: CameraFacing.BACK

getDefaultLiveFaceCamera

public final CameraFacing getDefaultLiveFaceCamera()

Type: CameraFacing
nullable: false
example: CameraFacing.FRONT

getDocumentCameraOrientation

public final CameraOrientation getDocumentCameraOrientation()

Type: CameraOrientation
nullable: false
example: CameraOrientation.PORTRAIT

getDocumentCameraToggle

public final Boolean getDocumentCameraToggle()

Type: Boolean
nullable: false
example: false

getDocumentCaptureCustomizationOptions

public final DocumentCaptureCustomizationOptions getDocumentCaptureCustomizationOptions()

Option to customize Document Capture and Instruction screens.

getGeolocationRequired

public final Boolean getGeolocationRequired()

Option to indicate whether users should be blocked from proceeding if they block location access.

getIdCaptureCustomizationOptions

public final IDCaptureCustomizationOptions getIdCaptureCustomizationOptions()

Option to customize ID Capture, Retry and Instruction screens.

getLanguage

public final LANGUAGE getLanguage()

Type: LANGUAGE
nullable: true
example:

 LANGUAGE.valueOf(EN)

getLiveFaceCameraToggle

public final Boolean getLiveFaceCameraToggle()

Type: Boolean
nullable: false
example: false

getSelfieCaptureCustomizationOptions

public final SelfieCaptureCustomizationOptions getSelfieCaptureCustomizationOptions()

Option to customize Selfie Capture, Retry and Instruction screens.

getSignatureCaptureCustomizationOptions

public final SignatureCaptureCustomizationOptions getSignatureCaptureCustomizationOptions()

Option to customize Signature Capture and Instruction screens.

getVideoIdCaptureCustomizationOptions

public final VideoIdCaptureCustomizationOptions getVideoIdCaptureCustomizationOptions()

Option to customize Video ID Capture screens.

getVoiceCaptureCustomizationOptions

public final VoiceCaptureCustomizationOptions getVoiceCaptureCustomizationOptions()

Option to customize Voice Capture screens.

isDebugMode

public final Boolean isDebugMode()

Option to set Debug mode. Whether or not to display debug information during capture. Default is false.

isScreenRecordingEnabled

public final Boolean isScreenRecordingEnabled()

Option to enable video recording and screenshots. Default is false.

setAutoFillCaptureCustomizationOptions

public final Unit setAutoFillCaptureCustomizationOptions(AutoFillCaptureCustomizationOptions autoFillCaptureCustomizationOptions)

Option to customize AutoFill Capture screens.

setBothCameraToggle

public final Unit setBothCameraToggle(Boolean bothCameraToggle)

Type: Boolean
nullable: false
example: false

setDebugMode

public final Unit setDebugMode(Boolean isDebugMode)

Option to set Debug mode. Whether or not to display debug information during capture. Default is false.

setDefaultDocumentCamera

public final Unit setDefaultDocumentCamera(CameraFacing defaultDocumentCamera)

Type: CameraFacing
nullable: false
example: CameraFacing.BACK

setDefaultLiveFaceCamera

public final Unit setDefaultLiveFaceCamera(CameraFacing defaultLiveFaceCamera)

Type: CameraFacing
nullable: false
example: CameraFacing.FRONT

setDocumentCameraOrientation

public final Unit setDocumentCameraOrientation(CameraOrientation documentCameraOrientation)

Type: CameraOrientation
nullable: false
example: CameraOrientation.PORTRAIT

setDocumentCameraToggle

public final Unit setDocumentCameraToggle(Boolean documentCameraToggle)

Type: Boolean
nullable: false
example: false

setDocumentCaptureCustomizationOptions

public final Unit setDocumentCaptureCustomizationOptions(DocumentCaptureCustomizationOptions documentCaptureCustomizationOptions)

Option to customize Document Capture and Instruction screens.

setGeolocationRequired

public final Unit setGeolocationRequired(Boolean geolocationRequired)

Option to indicate whether users should be blocked from proceeding if they block location access.

setIdCaptureCustomizationOptions

public final Unit setIdCaptureCustomizationOptions(IDCaptureCustomizationOptions idCaptureCustomizationOptions)

Option to customize ID Capture, Retry and Instruction screens.

setLanguage

public final Unit setLanguage(LANGUAGE language)

Type: LANGUAGE
nullable: true
example:

 LANGUAGE.valueOf(EN)

setLiveFaceCameraToggle

public final Unit setLiveFaceCameraToggle(Boolean liveFaceCameraToggle)

Type: Boolean
nullable: false
example: false

setScreenRecordingEnabled

public final Unit setScreenRecordingEnabled(Boolean isScreenRecordingEnabled)

Option to enable video recording and screenshots. Default is false.

setSelfieCaptureCustomizationOptions

public final Unit setSelfieCaptureCustomizationOptions(SelfieCaptureCustomizationOptions selfieCaptureCustomizationOptions)

Option to customize Selfie Capture, Retry and Instruction screens.

setSignatureCaptureCustomizationOptions

public final Unit setSignatureCaptureCustomizationOptions(SignatureCaptureCustomizationOptions signatureCaptureCustomizationOptions)

Option to customize Signature Capture and Instruction screens.

setVideoIdCaptureCustomizationOptions

public final Unit setVideoIdCaptureCustomizationOptions(VideoIdCaptureCustomizationOptions videoIdCaptureCustomizationOptions)

Option to customize Video ID Capture screens.

setVoiceCaptureCustomizationOptions

public final Unit setVoiceCaptureCustomizationOptions(VoiceCaptureCustomizationOptions voiceCaptureCustomizationOptions)

Option to customize Voice Capture screens.

writeToParcel

public abstract Unit writeToParcel(Parcel p0, Integer p1)