跳到主要内容

builder

FaceRecognition.Builder

| 参数 | 功能 | 是否必填 | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---- | | mobileToken | 客户密钥,用于标识收集的数据来源于您的应用程序。如果尚未收到您的 mobile-token,请联系支持团队。 | 是。 | | .setSandboxEnvironment() | 若在构造函数中使用此参数,库将配置为向沙盒环境发送数据。若不存在,请求将发送到生产环境。 | 否。 | | .showIntroductionScreens(Boolean showIntroductionScreens) | 设置为 "false" 时,禁用向用户显示的照片采集介绍屏幕。 | 否。默认值为 "true"。 | | .setShowSuccessScreen(Boolean showSuccessScreen) | 设置为 "false" 时,禁用照片采集后的成功屏幕。 | 否。默认值为 "true"。 | | .setBackgroundColor(String backgroundColor) | 允许配置 SDK activities 的背景颜色。 | 否。默认值为 "#ffffff"。 | | .setFontColor(String fontColor) | 允许配置 SDK activities 的字体和图标颜色。 | 否。默认值为 "#000000"。 | | .setFontFamily(FontFamily fontFamily) | 允许配置 SDK activities 的字体。 | 否。若未指定,默认为 FontFamily.open_sans。可用字体:FontFamily.open_sans、FontFamily.futura、FontFamily.verdana、FontFamily.roboto、FontFamily.poppins 和 FontFamily.helvetica。 | 否。 | | .activeFaceLiveness(Boolean activeFaceLiveness) | 指示 SDK 是否执行用户自拍采集或主动活体检测程序。 | 否。默认值为 false。 | | .audioConfiguration(AudioConfiguration audioConfiguration) | 指示 SDK 是否为用户播放提示音频。接受的配置为 AudioConfiguration.enable(播放提示音频)、AudioConfiguration.disable(不播放音频)和 AudioConfiguration.accessibility(当用户设备启用了无障碍配置时播放音频)。 | 否。默认值为 AudioConfiguration.disable。 | | .setVisualConfiguration(VisualConfiguration. visualConfiguration) | 用于自定义 SDK 执行过程中向用户显示的图片。 | 否。 | | .setTextConfiguration(TextConfiguration. textConfiguration) | 用于自定义 SDK 执行过程中向用户显示的引导屏幕上的文本。 | 否。 | | .setSessionId(String sessionId) | 用于设置标识 SDK 启动会话的密钥。用于通过日志跟踪用户在 FaceRecon 执行过程中的完整流程。此字段最多接受 255 个字符。 | 否。 | | .setLogLevel(FaceRecognition.LogLevel logLevel) | 用于自定义 SDK 日志的详细级别。可用级别:LogLevel.debug、LogLevel.info、LogLevel.warn、LogLevel.error 和 LogLevel.trace。默认为 LogLevel.debug。 | 否。 | | .setDocumentNumber(String documentNumber) | 用于设置用户的文档号码。此字段接受格式为 000.000.000-00 的 14 位 CPF 字符。 | 如果某次调用使用了 1:1 验证,则所有调用均必填。 | | .setValidation(Boolean validation) | 用于定义 SDK 是否对用户的自拍照执行 1:1 验证。在用户的第一次会话中,此标志必须为 false。此功能需要填写 setDocumentNumber 方法。 | 否。默认值为 false。 |

VisualConfiguration 对象

参数功能是否必填
.setOnboardingDrawable(int onboarding_drawable, int onboarding_width)用于配置在 SDK 引导屏幕上向用户显示的图片。参数 onboarding_drawable 应引用要显示的图片 ID,onboarding_width 是该图片的预期显示尺寸。否。
.setButtonBorderSize(int border_size)用于配置 SDK 按钮的边框宽度。否。默认值为 1
.setButtonShadow(boolean button_shadow)设置为 false 时,移除 SDK 按钮使用的 Android 默认阴影效果。否。默认值为 true

TextConfiguration 对象

参数功能是否必填
.setCustomText(CustomLabel label, String text)用于配置在 SDK 引导屏幕上向用户显示的文本否。