SybrinIdentityConfiguration

A base class containing configurable options for the SDK

import com.sybrin.identity.SybrinIdentityConfiguration

Provides an immutable reference to a configuration module used to control the look, feel, and behavior of the Sybrin Identity Android SDK.

In depth explanations and examples of how the SybrinIdentityConfiguration impacts the look, feel, and behavior of the Sybrin Identity Android SDK can be found within its Builder class.

Summary

Nested classes
class	SybrinIdentityConfiguration.Builder Builder for the immutable SybrinIdentityConfiguration class.

Public methods
CameraFacing	getCameraFacing()
String	getCorrelationID()
String	getCustomAuthorizationToken()
int	getCutoutCornerRadius()
String	getEnvironmentKey()
Language	getLanguage()
String	getLicense()
int	getOverlayBorderColor()
int	getOverlayBorderLength()
int	getOverlayBorderThickness()
int	getOverlayBrandingSubtitleColor()
String	getOverlayBrandingSubtitleText()
int	getOverlayBrandingTitleColor()
String	getOverlayBrandingTitleText()
int	getOverlayColor()
int	getOverlayLabelTextColor()
int	getOverlaySubLabelTextColor()
String[]	getPermissions()
int	getTorchButtonColor()
boolean	isEnableHelpMessage()
boolean	isEnableMultiPhaseVerification()
boolean	isEnablePartialScanning()
boolean	isEnableTorchButton()
boolean	saveImages()

Public methods

getCameraFacing

public CameraFacing getCameraFacing ()

Returns
CameraFacing	Which camera on the device is being used.

getCorrelationID

public String getCorrelationID ()

Returns
String	A unique identifier

getCustomAuthorizationToken

public String getCustomAuthorizationToken()

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

Returns
String	Custom authorization token to be used during the online calls within the SDK.

getCutoutCornerRadius

public boolean getCutoutCornerRadius ()

Returns
int	The radius of the overlay cutout corners.

getEnvironmentKey

public String getEnvironmentKey()

Returns
String	Key describing the SDK's environment variables.

getLanguage

public Language getLanguage()

Returns
Language	The language used by the SDK.

getLicense

public String getLicense()

Returns
String	The Sybrin Identity Android SDK License used by the SDK.

getOverlayBorderColor

public boolean getOverlayBorderColor ()

Returns
int	The color of the overlay border.

getOverlayBorderLength

public boolean getOverlayBorderLength ()

Returns
int	The length of the overlay border corner pieces.

getOverlayBorderThickness

public boolean getOverlayBorderThickness ()

Returns
int	The thickness of the overlay border.

getOverlayBrandingSubtitleColor

public boolean getOverlayBrandingSubtitleColor ()

Returns
int	Color of the branding subtitle text.

getOverlayBrandingSubtitleText

public boolean getOverlayBrandingSubtitleText ()

Returns
String	The overlay branding subtitle text.

getOverlayBrandingTitleColor

public boolean getOverlayBrandingTitleColor ()

Returns
int	Color of the overlay branding title text.

getOverlayBrandingTitleText

public boolean getOverlayBrandingTitleText ()

Returns
String	The overlay branding title text.

getOverlayColor

public boolean getOverlayColor ()

Returns
int	Color of the overlay.

getOverlayLabelTextColor

public boolean getOverlayLabelTextColor ()

Returns
int	Color of the overlay label text.

getOverlaySubLabelTextColor

public boolean getOverlaySubLabelTextColor ()

Returns
int	Color of the overlay sub-label text.

getPermissions

public String[] getPermissions ()

Returns
String[]	Array containing permissions used by the SDK.

getTorchButtonColor

public boolean getTorchButtonColor ()

Returns
int	Color of the torch button.

isEnableHelpMessage

public boolean isEnableHelpMessage ()

Returns
boolean	Whether the help message is enable or not.

isEnableMultiPhaseVerification

public boolean isEnableMultiPhaseVerification ()

Returns
boolean	Whether verification between scanning phases is enabled or not.

isEnablePartialScanning

public boolean isEnablePartialScanning ()

Returns
boolean	Whether partial scanning for documents is enabled or not. This is only supported for Philippines documents

isEnableTorchButton

public boolean isEnableTorchButton ()

Returns
boolean	Whether the torch button is visible or not.

saveImages

public boolean saveImages ()

Returns
boolean	Whether the SDK should save all captured images after scanning completion.