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.BuilderenableHelpMessage (boolean enableHelpMessage)

Default value: true Sets the visibility of the help message.

Visual Example:

enableMultiPhaseVerification

public SybrinIdentityConfiguration.BuilderenableMultiPhaseVerification (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.BuilderenablePartialScanning (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.BuilderenableTorchButton (boolean enableTorchButton)

Default value: true Sets the visibility of the torch button.

Visual Example:

saveImages

public SybrinIdentityConfiguration.BuildersaveImages (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.BuildersetCameraFacing (CameraFacing cameraFacing)

Default value: CameraFacing.Back Sets the direction of the camera that is used for the scanning process.

setCorrelationID

public SybrinIdentityConfiguration.BuildersetCorrelationID (String correlationID)

Default value: null Sets the correlation ID.

setCustomAuthorizationToken

public SybrinIdentityConfiguration.BuildersetCustomAuthorizationToken (String customAuthorizationToken)

Specifies a custom authorization token to be used during the online calls within the SDK.

setCutoutCornerRadius

public SybrinIdentityConfiguration.BuildersetCutoutCornerRadius (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.

setLanguage

public SybrinIdentityConfiguration.Builder setLanguage(Language language)

Sets the language to be used within the SDK.

setOverlayBorderColor

public SybrinIdentityConfiguration.BuildersetOverlayBorderColor (int overlayBorderColor)

Default value: Color.WHITE Sets the color of the overlay cutout border.

Visual Example:

setOverlayBorderLength

public SybrinIdentityConfiguration.BuildersetOverlayBorderLength (int overlayBorderLength)

Default value: 40 Sets the length of the overlay cutout border corner pieces.

Visual Example:

setOverlayBorderThickness

public SybrinIdentityConfiguration.BuildersetOverlayBorderThickness (int overlayBorderThickness)

Default value: 7 Sets the thickness of the overlay cutout border.

Visual Example:

setOverlayBrandingSubtitleColor

public SybrinIdentityConfiguration.BuildersetOverlayBrandingSubtitleColor (int overlayBrandingSubtitleColor)

Default value: Color.WHITE Sets the text color of the branding subtitle.

Visual Example:

setOverlayBrandingSubtitleText

public SybrinIdentityConfiguration.BuildersetOverlayBrandingSubtitleText (String overlayBrandingSubtitleText)

Default value: "" Sets the text of the branding subtitle.

Visual Example:

setOverlayBrandingTitleColor

public SybrinIdentityConfiguration.BuildersetOverlayBrandingTitleColor (int overlayBrandingTitleColor)

Default value: Color.WHITE Sets the text color of the branding title.

Visual Example:

setOverlayBrandingTitleText

public SybrinIdentityConfiguration.BuildersetOverlayBrandingTitleText (String overlayBrandingTitleText)

Default value: "" Sets the text of the branding title.

Visual Example:

setOverlayColor

public SybrinIdentityConfiguration.BuildersetOverlayColor (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.BuildersetOverlayLabelTextColor (int overlayLabelTextColor)

Default value: Color.WHITE Sets the color of the overlay label text.

Visual Example:

setOverlaySubLabelTextColor

public SybrinIdentityConfiguration.BuildersetOverlaySubLabelTextColor (int overlaySubLabelTextColor)

Default value: Color.WHITE Sets the color of the overlay sub-label text.

Visual Example:

setTorchButtonColor

public SybrinIdentityConfiguration.BuildersetTorchButtonColor (int torchButtonColor)

Default value: Color.WHITE Sets the color of the torch button.

Visual Example: