SybrinIdentityConfiguration.Builder

import com.sybrin.identity.SybrinIdentityConfiguration

Builder for the immutable SybrinIdentityConfiguration class

Summary

Public constructors

Builder(String license) Creates a new Builder using a Sybrin Identity Android License.

Public methods
SybrinIdentityConfiguration	build() Creates and returns a built SybrinIdentityConfiguration object.
SybrinIdentityConfiguration.Builder	enableHelpMessage(boolean enableHelpMessage) Sets the visibility of the help message.
SybrinIdentityConfiguration.Builder	enableMultiPhaseVerification(boolean enableMultiPhaseVerification) Sets whether the verification between scanning phases is enabled.
SybrinIdentityConfiguration.Builder	enablePartialScanning(boolean enablePartialScanning) Sets whether there is partial scanning of documents.
SybrinIdentityConfiguration.Builder	enableTorchButton(boolean enableTorchButton) Sets the visibility of the torch button.
SybrinIdentityConfiguration.Builder	saveImages(boolean saveImages) Sets whether the SDK should save all captured images to the device upon completion of the scanning process.
SybrinIdentityConfiguration.Builder	setCameraFacing(CameraFacing cameraFacing) Sets the direction of the camera that is used for the scanning process.
SybrinIdentityConfiguration.Builder	setCustomAuthorizationToken(String customAuthorizationToken) Specifies a custom authorization token to be used during the online calls within the SDK.
SybrinIdentityConfiguration.Builder	setCutoutCornerRadius(int CutoutCornerRadius) Sets the radius of the overlay cutout corners.
SybrinIdentityConfiguration.Builder	setEnvironmentKey(String environmentKey) Sets key that defines the SDK's internal environment variables.
SybrinIdentityConfiguration.Builder	setLanguage(Language language) Sets language to be used within the SDK.
SybrinIdentityConfiguration.Builder	setOverlayBorderColor(int overlayBorderColor) Sets the color of the overlay cutout border.
SybrinIdentityConfiguration.Builder	setOverlayBorderLength(int overlayBorderLength) Sets the length of the overlay cutout border corner pieces.
SybrinIdentityConfiguration.Builder	setOverlayBorderThickness(int overlayBorderThickness) Sets the thickness of the overlay cutout border.
SybrinIdentityConfiguration.Builder	setOverlayBrandingSubtitleColor(int overlayBrandingSubtitleColor) Sets the text color of the branding subtitle.
SybrinIdentityConfiguration.Builder	setOverlayBrandingSubtitleText(String overlayBrandingSubtitleText) Sets the text of the branding subtitle.
SybrinIdentityConfiguration.Builder	setOverlayBrandingTitleColor(int overlayBrandingTitleColor) Sets the text color of the branding title.
SybrinIdentityConfiguration.Builder	setOverlayBrandingTitleText(String overlayBrandingTitleText) Sets the text of the branding title.
SybrinIdentityConfiguration.Builder	setOverlayColor(int overlayColor) Sets the color of the overlay.
SybrinIdentityConfiguration.Builder	setOverlayLabelTextColor(int overlayLabelTextColor) Sets the color of the overlay label text.
SybrinIdentityConfiguration.Builder	setOverlaySubLabelTextColor(int overlaySubLabelTextColor) Sets the color of the overlay sub-label text.
SybrinIdentityConfiguration.Builder	setTorchButtonColor(int torchButtonColor) Sets the color of the torch button.

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.

Returns
SybrinIdentityConfiguration	This value cannot be null.

enableHelpMessage

public SybrinIdentityConfiguration.BuilderenableHelpMessage (boolean enableHelpMessage)

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

Parameters
enableHelpMessage	boolean: true if help message is enabled, false if help message is disabled.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - No help message

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.

Parameters
enableMultiPhaseVerification	boolean: true if verification across scan phases is enabled, false if verification across scan phases is disabled.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

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

Parameters
enablePartialScanning	boolean: true enables partial scanning of documents, false disables partial scanning of documents.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

enableTorchButton

public SybrinIdentityConfiguration.BuilderenableTorchButton (boolean enableTorchButton)

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

Parameters
enableTorchButton	boolean: true if torch button is visible, false if torch button is invisible.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Torch button disabled

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.

Parameters
saveImages	boolean: true if captured images should be saved, false if captured images should not be saved.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

setCameraFacing

public SybrinIdentityConfiguration.BuildersetCameraFacing (CameraFacing cameraFacing)

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

Parameters
cameraFacing	CameraFacing: CameraFacing.Back if the camera to be used during the scanning process is at the back of the device. CameraFacing.Front if the camera to be used during the scanning process is at the front of the device.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

setCorrelationID

public SybrinIdentityConfiguration.BuildersetCorrelationID (String correlationID)

Default value: null Sets the correlation ID.

Parameters
correctionID	String: The correlation ID

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

setCustomAuthorizationToken

public SybrinIdentityConfiguration.BuildersetCustomAuthorizationToken (String customAuthorizationToken)

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

Parameters
customAuthorizationToken	String: The custom authorization token

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

setCutoutCornerRadius

public SybrinIdentityConfiguration.BuildersetCutoutCornerRadius (int CutoutCornerRadius)

Default value: 0 Sets the radius of the overlay cutout corners.

Parameters
setCutoutCornerRadius	int: The radius of the rounded corners of the overlay cutout.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Corner radius 30, border disabled

setEnvironmentKey

public SybrinIdentityConfiguration.Builder setEnvironmentKey(String environmentKey)

Sets key that defines the SDK's internal environment variables.

Parameters
setEnvironmentKey	String: Key that defines SDK environment variables. Value cannot be null.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

setLanguage

public SybrinIdentityConfiguration.Builder setLanguage(Language language)

Sets the language to be used within the SDK.

Parameters
language	Language: The language that is to be used within the SDK

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

setOverlayBorderColor

public SybrinIdentityConfiguration.BuildersetOverlayBorderColor (int overlayBorderColor)

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

Parameters
setOverlayBorderColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Border color green

setOverlayBorderLength

public SybrinIdentityConfiguration.BuildersetOverlayBorderLength (int overlayBorderLength)

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

Parameters
setOverlayBorderLength	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Border length 150

setOverlayBorderThickness

public SybrinIdentityConfiguration.BuildersetOverlayBorderThickness (int overlayBorderThickness)

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

Parameters
setOverlayBorderThickness	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Border thickness 20	Configured - Border thickness 0

setOverlayBrandingSubtitleColor

public SybrinIdentityConfiguration.BuildersetOverlayBrandingSubtitleColor (int overlayBrandingSubtitleColor)

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

Parameters
setOverlayBrandingSubtitleColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Branding subtitle color green

setOverlayBrandingSubtitleText

public SybrinIdentityConfiguration.BuildersetOverlayBrandingSubtitleText (String overlayBrandingSubtitleText)

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

Parameters
setOverlayBrandingSubtitleText	String: Text that is shown as the branding subtitle. Value cannot be null.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Branding subtitle text

setOverlayBrandingTitleColor

public SybrinIdentityConfiguration.BuildersetOverlayBrandingTitleColor (int overlayBrandingTitleColor)

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

Parameters
setOverlayBrandingTitleColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Branding title color green

setOverlayBrandingTitleText

public SybrinIdentityConfiguration.BuildersetOverlayBrandingTitleText (String overlayBrandingTitleText)

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

Parameters
setOverlayBrandingTitleText	String: Text that is shown as the branding title. Value cannot be null.

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured -Branding title text

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.

Parameters
setOverlayColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Overlay color green	Configured - Overlay color green with opacity

setOverlayLabelTextColor

public SybrinIdentityConfiguration.BuildersetOverlayLabelTextColor (int overlayLabelTextColor)

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

Parameters
setOverlayLabelTextColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Label text color green

setOverlaySubLabelTextColor

public SybrinIdentityConfiguration.BuildersetOverlaySubLabelTextColor (int overlaySubLabelTextColor)

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

Parameters
setOverlaySubLabelTextColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Sub-label color green

setTorchButtonColor

public SybrinIdentityConfiguration.BuildersetTorchButtonColor (int torchButtonColor)

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

Parameters
setTorchButtonColor	int

Returns
SybrinIdentityConfiguration.Builder	This value cannot be null.

Visual Example:

Default	Configured - Torch button green