Mobile SDKs18 pages

SDKCustomizationOptions

← Browse native SDK reference

On this page · 5 sections
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

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)
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)
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)
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)
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)
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)
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)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera, CameraFacing defaultDocumentCamera, CameraOrientation documentCameraOrientation, Boolean isDebugMode, Boolean isScreenRecordingEnabled, SelfieCaptureCustomizationOptions selfieCaptureCustomizationOptions)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera, CameraFacing defaultDocumentCamera, CameraOrientation documentCameraOrientation, Boolean isDebugMode, Boolean isScreenRecordingEnabled)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera, CameraFacing defaultDocumentCamera, CameraOrientation documentCameraOrientation, Boolean isDebugMode)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera, CameraFacing defaultDocumentCamera, CameraOrientation documentCameraOrientation)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera, CameraFacing defaultDocumentCamera)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle, CameraFacing defaultLiveFaceCamera)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle, Boolean liveFaceCameraToggle)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle, Boolean documentCameraToggle)
public SDKCustomizationOptions SDKCustomizationOptions(LANGUAGE language, Boolean bothCameraToggle)

Properties

Type: Boolean
nullable: false
example: false

Type: CameraFacing
nullable: false
example: CameraFacing.BACK

Type: CameraFacing
nullable: false
example: CameraFacing.FRONT

Type: CameraOrientation
nullable: false
example: CameraOrientation.PORTRAIT

Type: Boolean
nullable: false
example: false

Option to customize Document Capture and Instruction screens.

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

Option to customize ID Capture, Retry and Instruction screens.

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

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

private LANGUAGE language

Type: LANGUAGE
nullable: true
example:

 LANGUAGE.valueOf(EN) 

Type: Boolean
nullable: false
example: false

Option to customize Selfie Capture, Retry and Instruction screens.

Option to customize Signature Capture and Instruction screens.

Functions

Type: Boolean
nullable: false
example: false

Type: CameraFacing
nullable: false
example: CameraFacing.BACK

Type: CameraFacing
nullable: false
example: CameraFacing.FRONT

Type: CameraOrientation
nullable: false
example: CameraOrientation.PORTRAIT

Type: Boolean
nullable: false
example: false

Option to customize Document Capture and Instruction screens.

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

Option to customize ID Capture, Retry and Instruction screens.

public final LANGUAGE getLanguage()

Type: LANGUAGE
nullable: true
example:

 LANGUAGE.valueOf(EN) 

Type: Boolean
nullable: false
example: false

Option to customize Selfie Capture, Retry and Instruction screens.

Option to customize Signature Capture and Instruction screens.

public final Boolean isDebugMode()

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

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

public final Unit setAutoFillCaptureCustomizationOptions(AutoFillCaptureCustomizationOptions autoFillCaptureCustomizationOptions)

Option to customize AutoFill Capture screens.

public final Unit setBothCameraToggle(Boolean bothCameraToggle)

Type: Boolean
nullable: false
example: false

public final Unit setDebugMode(Boolean isDebugMode)

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

public final Unit setDefaultDocumentCamera(CameraFacing defaultDocumentCamera)

Type: CameraFacing
nullable: false
example: CameraFacing.BACK

public final Unit setDefaultLiveFaceCamera(CameraFacing defaultLiveFaceCamera)

Type: CameraFacing
nullable: false
example: CameraFacing.FRONT

public final Unit setDocumentCameraOrientation(CameraOrientation documentCameraOrientation)

Type: CameraOrientation
nullable: false
example: CameraOrientation.PORTRAIT

public final Unit setDocumentCameraToggle(Boolean documentCameraToggle)

Type: Boolean
nullable: false
example: false

public final Unit setDocumentCaptureCustomizationOptions(DocumentCaptureCustomizationOptions documentCaptureCustomizationOptions)

Option to customize Document Capture and Instruction screens.

public final Unit setGeolocationRequired(Boolean geolocationRequired)

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

public final Unit setIdCaptureCustomizationOptions(IDCaptureCustomizationOptions idCaptureCustomizationOptions)

Option to customize ID Capture, Retry and Instruction screens.

public final Unit setLanguage(LANGUAGE language)

Type: LANGUAGE
nullable: true
example:

 LANGUAGE.valueOf(EN) 

public final Unit setLiveFaceCameraToggle(Boolean liveFaceCameraToggle)

Type: Boolean
nullable: false
example: false

public final Unit setScreenRecordingEnabled(Boolean isScreenRecordingEnabled)

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

public final Unit setSelfieCaptureCustomizationOptions(SelfieCaptureCustomizationOptions selfieCaptureCustomizationOptions)

Option to customize Selfie Capture, Retry and Instruction screens.

public final Unit setSignatureCaptureCustomizationOptions(SignatureCaptureCustomizationOptions signatureCaptureCustomizationOptions)

Option to customize Signature Capture and Instruction screens.

public final Unit setVideoIdCaptureCustomizationOptions(VideoIdCaptureCustomizationOptions videoIdCaptureCustomizationOptions)

Option to customize Video ID Capture screens.

public final Unit setVoiceCaptureCustomizationOptions(VoiceCaptureCustomizationOptions voiceCaptureCustomizationOptions)

Option to customize Voice Capture screens.

public abstract Unit writeToParcel(Parcel p0, Integer p1)
Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.