Biometrics Android
1.3
Search
K

SybrinFacialComparisonConfiguration.Builder

import com.sybrin.facecomparison.SybrinFacialComparisonConfiguration
Builder for the immutable SybrinFacialComparisonConfiguration class

Summary

Public constructors
Builder(String license)
Public methods
build()
Creates and returns a built SybrinFacialComparisonConfiguration object.
cloneConfiguration(Builder configuration)
Clones the properties from an already created SybrinFacialComparisonConfiguration object.
setCorrelationId(String correlationId)
Sets a unique value that is associated with the scan.
setCustomAuthorizationToken(String customAuthorizationToken)
Specifies a custom authorization token to be used during the online calls within the SDK.
setEnvironmentKey(String environmentKey)
Sets key that defines the SDK's internal environment variables.
saveImages(boolean saveImages)
Sets whether the SDK should save all captured images to the device upon completion of the facial comparison process.

Public constructors

Builder

public Builder (String license)

Public methods

build

Creates and returns a built SybrinFacialComparisonConfiguration object.
Returns
This value cannot be null.

cloneConfiguration

Clones the properties from an already created SybrinFacialComparisonConfiguration object.
Parameters
configuration
SybrinFacialComparisonConfiguration: An instance of a built configuration object..
Returns
This value cannot be null.

setCorrelationId

public SybrinFacialComparisonConfiguration.Builder setCorrelationId(String correlationId)
Sets a unique value that is associated with the scan. Can be used to associate different SDK components in the back-end.
Parameters
setCorrelationId
String: Unique string identifying scan. Value cannot be null.
Returns
This value cannot be null.

setCustomAuthorizationToken

public SybrinFacialComparisonConfiguration.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
This value cannot be null.

setEnvironmentKey

public SybrinFacialComparisonConfiguration.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
This value cannot be null.

saveImages

public SybrinFacialComparisonConfiguration.Builder saveImages (boolean saveImages)
Default value: false Sets whether the SDK should save all captured images to the device upon completion of the facial comparison 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.