The ZaigWebFaceRecon.WebFaceRecon() constructor
Important Warning!
Starting from version 3.0.0 the WebFaceRecon constructor was changed.
The .WebFaceRecon method is responsible for configuring the instance of your facial recognition component. This method presents the following configurations.
| Name | Description | Required |
|---|---|---|
| .setSandboxEnvironment() | Method used to configure the environment for Sandbox mode. | No |
| .setShowInvalidTokenScreen(Boolean) | Method used to configure whether the authentication failure screen should be shown. If not provided, the default is false. | No |
| .setShowBackButton(Boolean) | Method used to configure whether the back button (if pressed ends the flow) should be shown. If not provided, the default is true. | No |
| .setSessionId(String) | Used to define the key that identifies the session started in the SDK. It is used to track the entire flow traversed by the user in the Web FaceRecon execution through logs. This field accepts a string of up to 255 characters. | No |
| .setThemeConfiguration(object) | Method used to customize the visual identity of the webfacerecon element components. | No |
| .setLogLevel(String) | Used to customize the verbosity level of Web FaceRecon logs. Available levels: "info", "debug", "warn" and "error". The default is "info". | No |
The .setThemeConfiguration method must receive an object with the following fields:
| name | type | description |
|---|---|---|
| buttonColor | String | (required) Hexadecimal color of the screen buttons. If not provided, the default is #FFFFFF. |
| fontColor | String | (required) Hexadecimal color of the texts shown on the screen. If not provided, the default is #000000. |
| backgroundColor | String | (required) Hexadecimal color of the screen background. If not provided, the default is #FFFFFF. |
Previous Versions
| Name | Description | Required |
|---|---|---|
| web_token | Client key that identifies that the collected data comes from your application. If you have not yet received your web-token, contact support. | Yes |
| .setSandboxEnvironment() | Method used to configure the environment for Sandbox mode. | No |
| .setSessionId(String) | Used to define the key that identifies the session started in the SDK. It is used to track the entire flow traversed by the user in the Web FaceRecon execution through logs. This field accepts a string of up to 255 characters. | No |
| .setThemeConfiguration(object) | Method used to customize the visual identity of the webfacerecon element components. | No |
| .setLogLevel(String) | Used to customize the verbosity level of Web FaceRecon logs. Available levels: "info", "debug", "warn" and "error". The default is "info". | No |