SybrinFacialComparisonConfiguration.Builder
Last updated
Last updated
import com.sybrin.facecomparison.SybrinFacialComparisonConfiguration
Builder for the immutable SybrinFacialComparisonConfiguration class
public Builder (String license)
Creates a new Builder using a Sybrin Biometrics Android License.
public SybrinFacialComparisonConfiguration build ()
Creates and returns a built SybrinFacialComparisonConfiguration object.
public SybrinFacialComparisonConfiguration.Builder cloneConfiguration(SybrinFacialComparisonConfiguration configuration)
Clones the properties from an already created SybrinFacialComparisonConfiguration object.
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.
public SybrinFacialComparisonConfiguration.BuildersetCustomAuthorizationToken (String customAuthorizationToken)
Specifies a custom authorization token to be used during the online calls within the SDK.
public SybrinFacialComparisonConfiguration.Builder setEnvironmentKey(String environmentKey)
Sets key that defines the SDK's internal environment variables.
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.
Public constructors
Builder(String license)
Creates a new Builder using a Sybrin Biometrics Android 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.
Returns
This value cannot be null.
Parameters
configuration
SybrinFacialComparisonConfiguration: An instance of a built configuration object..
Returns
This value cannot be null.
Parameters
setCorrelationId
String: Unique string identifying scan. Value cannot be null.
Returns
This value cannot be null.
Parameters
customAuthorizationToken
String: The custom authorization token
Returns
This value cannot be null.
Parameters
setEnvironmentKey
String: Key that defines SDK environment variables. Value cannot be null.
Returns
This value cannot be null.
Parameters
saveImages
boolean: true if captured images should be saved, false if captured images should not be saved.
Returns
This value cannot be null.