SybrinIdentityConfiguration.Builder
import com.sybrin.identity.SybrinIdentityConfiguration
Public constructors |
Public methods | |
Sets whether the verification between scanning phases is enabled. | |
Sets whether there is partial scanning of documents. | |
Sets whether the SDK should save all captured images to the device upon completion of the scanning process. | |
Sets the direction of the camera that is used for the scanning process. | |
Specifies a custom authorization token to be used during the online calls within the SDK. | |
Sets key that defines the SDK's internal environment variables. | |
Sets the length of the overlay cutout border corner pieces. | |
Sets the thickness of the overlay cutout border. | |
Sets the text color of the branding subtitle. | |
Sets the text of the branding subtitle. | |
Sets the text color of the branding title. | |
Sets the color of the overlay sub-label text. | |
public Builder (String license)
Returns | |
This value cannot be null . |
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 | |
This value cannot be null . |
Default | Configured - No help message |
![]() | ![]() |
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.Parameters | |
enableMultiPhaseVerification | boolean: true if verification across scan phases is enabled, false if verification across scan phases is disabled. |
Returns | |
This value cannot be null . |
Default value:
true
Sets whether partial scanning for documents is enabled or not. This is only supported for Philippines documents currentlyParameters | |
enablePartialScanning | boolean: true enables partial scanning of documents, false disables partial scanning of documents. |
Returns | |
This value cannot be null . |
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 | |
This value cannot be null . |
Default | Configured - Torch button disabled |
![]() | ![]() |
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 | |
This value cannot be null . |
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 | |
This value cannot be null . |
Default value: null
Sets the correlation ID.
Parameters | |
correctionID | String: The correlation ID |
Returns | |
This value cannot be null . |
public
SybrinIdentityConfiguration.Builder
setCustomAuthorizationToken (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 | |
This value cannot be null . |
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 | |
This value cannot be null . |
Default | Configured - Corner radius 30, border disabled |
![]() | ![]() |
Sets key that defines the SDK's internal environment variables.
Parameters | |
setEnvironmentKey | String: Key that defines SDK environment variables. Value cannot be null . |
Returns | |
This value cannot be null . |
Sets the language to be used within the SDK.
Parameters | |
language | Language: The language that is to be used within the SDK |
Returns | |
This value cannot be null . |
Default value:
Color.WHITE
Sets the color of the overlay cutout border.Parameters | |
setOverlayBorderColor | int |
Returns | |
This value cannot be null . |
Default | Configured - Border color green |
![]() | ![]() |
Default value:
40
Sets the length of the overlay cutout border corner pieces.Parameters | |
setOverlayBorderLength | int |
Returns | |
This value cannot be null . |
Default | Configured - Border length 150 |
![]() | ![]() |
Default value:
7
Sets the thickness of the overlay cutout border.Parameters | |
setOverlayBorderThickness | int |
Returns | |
This value cannot be null . |
Default | Configured - Border thickness 20 | Configured - Border thickness 0 |
![]() | ![]() | ![]() |
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingSubtitleColor (int overlayBrandingSubtitleColor)
Default value:
Color.WHITE
Sets the text color of the branding subtitle.Parameters | |
setOverlayBrandingSubtitleColor | int |
Returns | |
This value cannot be null . |
Default | Configured - Branding subtitle color green |
![]() | ![]() |
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingSubtitleText (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 | |
This value cannot be null . |
Default | Configured - Branding subtitle text |
![]() | ![]() |
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingTitleColor (int overlayBrandingTitleColor)
Default value:
Color.WHITE
Sets the text color of the branding title.Parameters | |
setOverlayBrandingTitleColor | int |
Returns | |
This value cannot be null . |
Default | Configured - Branding title color green |
![]() | ![]() |
public
SybrinIdentityConfiguration.Builder
setOverlayBrandingTitleText (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 | |
This value cannot be null . |
Default | Configured -Branding title text |
![]() | ![]() |
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 | |
This value cannot be null . |
Default | Configured - Overlay color green | Configured - Overlay color green with opacity |
![]() | ![]() | ![]() |
Default value:
Color.WHITE
Sets the color of the overlay label text.Parameters | |
setOverlayLabelTextColor | int |
Returns | |
This value cannot be null . |
Default | Configured - Label text color green |
![]() | ![]() |
public
SybrinIdentityConfiguration.Builder
setOverlaySubLabelTextColor (int overlaySubLabelTextColor)
Default value:
Color.WHITE
Sets the color of the overlay sub-label text.Parameters | |
setOverlaySubLabelTextColor | int |
Returns | |
This value cannot be null . |
Default | Configured - Sub-label color green |
![]() | ![]() |
Default value:
Color.WHITE
Sets the color of the torch button.Parameters | |
setTorchButtonColor | int |
Returns | |
This value cannot be null . |
Default | Configured - Torch button green |
![]() | ![]() |
Last modified 10mo ago