SybrinIdentityConfiguration.Builder
import com.sybrin.identity.SybrinIdentityConfiguration
Builder for the immutable SybrinIdentityConfiguration class
Summary
Public constructors
Builder
public Builder (String license)
Creates a new Builder using a Sybrin Identity Android License.
Public methods
build
public
SybrinIdentityConfiguration
build ()
Creates and returns a built SybrinIdentityConfiguration object.
enableHelpMessage
public
SybrinIdentityConfiguration.Builder
enableHelpMessage (boolean enableHelpMessage)
Default value: true
Sets the visibility of the help message.
Visual Example:
enableMultiPhaseVerification
public
SybrinIdentityConfiguration.Builder
enableMultiPhaseVerification (boolean enableMultiPhaseVerification)
Default value: false
Sets whether the verification between scanning phases is enabled. An example of this would be to check if the data on the front of an ID Card matches the data found on the back.
enablePartialScanning
public
SybrinIdentityConfiguration.Builder
enablePartialScanning (boolean enablePartialScanning)
Default value: true
Sets whether partial scanning for documents is enabled or not. This is only supported for Philippines documents currently
enableTorchButton
public
SybrinIdentityConfiguration.Builder
enableTorchButton (boolean enableTorchButton)
Default value: true
Sets the visibility of the torch button.
Visual Example:
saveImages
public
SybrinIdentityConfiguration.Builder
saveImages (boolean saveImages)
Default value: false
Sets whether the SDK should save all captured images to the device upon completion of the scanning process.
setCameraFacing
public
SybrinIdentityConfiguration.Builder
setCameraFacing (
CameraFacing
cameraFacing)
Default value: CameraFacing.Back
Sets the direction of the camera that is used for the scanning process.
setCorrelationID
public
SybrinIdentityConfiguration.Builder
setCorrelationID (String correlationID)
Default value: null Sets the correlation ID.
setCutoutCornerRadius
public
SybrinIdentityConfiguration.Builder
setCutoutCornerRadius (int CutoutCornerRadius)
Default value: 0
Sets the radius of the overlay cutout corners.
Visual Example:
setEnvironmentKey
public
SybrinIdentityConfiguration.Builder
setEnvironmentKey(String environmentKey)
Sets key that defines the SDK's internal environment variables.
setOverlayBorderColor
public
SybrinIdentityConfiguration.Builder
setOverlayBorderColor (int overlayBorderColor)
Default value: Color.WHITE
Sets the color of the overlay cutout border.
Visual Example:
setOverlayBorderLength
public
SybrinIdentityConfiguration.Builder
setOverlayBorderLength (int overlayBorderLength)
Default value: 40
Sets the length of the overlay cutout border corner pieces.
Visual Example:
setOverlayBorderThickness
public
SybrinIdentityConfiguration.Builder
setOverlayBorderThickness (int overlayBorderThickness)
Default value: 7
Sets the thickness of the overlay cutout border.
Visual Example:
setOverlayBrandingSubtitleColor
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingSubtitleColor (int overlayBrandingSubtitleColor)
Default value: Color.WHITE
Sets the text color of the branding subtitle.
Visual Example:
setOverlayBrandingSubtitleText
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingSubtitleText (String overlayBrandingSubtitleText)
Default value: ""
Sets the text of the branding subtitle.
Visual Example:
setOverlayBrandingTitleColor
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingTitleColor (int overlayBrandingTitleColor)
Default value: Color.WHITE
Sets the text color of the branding title.
Visual Example:
setOverlayBrandingTitleText
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingTitleText (String overlayBrandingTitleText)
Default value: ""
Sets the text of the branding title.
Visual Example:
setOverlayColor
public
SybrinIdentityConfiguration.Builder
setOverlayColor (int overlayColor)
Default value: Color.argb(80, Color.red(Color.BLACK), Color.green(Color.BLACK), Color.blue(Color.BLACK))
Sets the color of the overlay.
Visual Example:
setOverlayLabelTextColor
public
SybrinIdentityConfiguration.Builder
setOverlayLabelTextColor (int overlayLabelTextColor)
Default value: Color.WHITE
Sets the color of the overlay label text.
Visual Example:
setOverlaySubLabelTextColor
public
SybrinIdentityConfiguration.Builder
setOverlaySubLabelTextColor (int overlaySubLabelTextColor)
Default value: Color.WHITE
Sets the color of the overlay sub-label text.
Visual Example:
setTorchButtonColor
public
SybrinIdentityConfiguration.Builder
setTorchButtonColor (int torchButtonColor)
Default value: Color.WHITE
Sets the color of the torch button.
Visual Example:
Last updated