builder

DocumentRecognition.Builder

Parâmetro	Função	Obrigatório
mobileToken	Chave do cliente que identifica que os dados coletados são provenientes do seu aplicativo. Caso ainda não tenha recebido o seu mobile-token, entre em contato com o suporte.	Sim.
.setDocumentSteps(DocumentRecognitionStep[] documentSteps)	Define o fluxo de captura de documentos realizado pelo usuário. Mais informações aqui	Sim.
.setSandboxEnvironment()	Caso este parâmetro seja utilizado no construtor, a biblioteca será configurada para enviar os dados ao ambiente de sandbox. Caso ausente, as requisições são enviadas para o ambiente production.	Não.
.showIntroductionScreens(Boolean showIntroductionScreens)	Quando "false" desativa as telas de introdução à coleta de foto do documento que aparecem para o usuário.	Não. O padrão é "true".
.setShowSuccessScreen(Boolean showSuccessScreen)	Quando "false" desativa a tela de sucesso após a coleta da foto.	Não. O padrão é "true".
.setBackgroundColor(String backgroundColor)	Permite a configuração da cor de background das activities do SDK.	Não. O padrão é "#ffffff".
.setFontColor(String fontColor)	Permite a configuração da cor da fonte e dos ícones das activities do SDK.	Não. O padrão é "#000000".
.setFontFamily(FontFamily fontFamily)	Permite a configuração da fonte das activities do SDK.	Não. Caso não seja informada o padrão é FontFamily.open_sans. Fontes disponíveis: FontFamily.open_sans, FontFamily.futura, FontFamily.verdana, FontFamily.roboto, FontFamily.poppins e FontFamily.helvetica.
.setVisualConfiguration(VisualConfiguration. visualConfiguration)	Utilizado para customizar as imagens mostradas para o usuário ao longo da execução do SDK.	Não.
.setTextConfiguration(TextConfiguration. textConfiguration)	Utilizado para customizar os textos da tela introdutória de onboarding mostradas para o usuário ao longo da execução do SDK.	Não.
.setSessionId(String sessionId)	Utilizado para definir a chave que identifica a sessão iniciada no SDK. É usada para rastrear todo fluxo percorrido pelo usuário na execução da FaceRecon através de logs. Este campo aceita até 255 caracteres.	Não.
.setLogLevel(DocumentRecognition.LogLevel logLevel)	Utilizado para customizar o nível de verbosidade dos logs do SDK. Níveis disponíveis: LogLevel.debug, LogLevel.info, LogLevel.warn, LogLevel.error e LogLevel.trace. O padrão é LogLevel.debug.	Não.
.setAudioConfiguration(AudioConfiguration audioConfiguration)	Configura o guiamento por voz do SDK, que narra as instruções de captura em tempo real. As configurações aceitas são AudioConfiguration.enable, que exibe o botão de ligar/desligar áudio com a narração iniciando desligada; AudioConfiguration.disable, que desativa a narração e oculta o botão; e AudioConfiguration.accessibility, que exibe o botão com a narração iniciando ligada quando o dispositivo possui recursos de acessibilidade ativos. Com o TalkBack ativo, as instruções completas são entregues pelo próprio leitor de telas.	Não. O padrão é AudioConfiguration.disable.
.setLanguage(String language)	Define o idioma das telas, das mensagens de acessibilidade e do guiamento por voz do SDK, no formato BCP 47 (por exemplo pt-BR, en, es ou zh-Hans). Idiomas suportados: português (pt, pt-BR), inglês (en, en-US), espanhol neutro (es, es-MX, es-419) e chinês simplificado (zh, zh-Hans, zh-CN). Maiúsculas e minúsculas são indiferentes e _ também é aceito como separador (pt_BR). Uma tag não suportada (como fr ou zh-TW) exibe o SDK em inglês e registra um aviso nos logs. O idioma do dispositivo não é considerado.	Não. Caso não seja informado o padrão é português.

Idioma

• O SDK nunca usa o idioma do dispositivo: quem escolhe é a sua integração. Para seguir o idioma do seu aplicativo, repasse a tag dele, por exemplo Locale.getDefault().toLanguageTag().
• Textos personalizados de onboarding (onboardingTextConfiguration) são exibidos exatamente como enviados. Envie-os já traduzidos para o idioma escolhido.
• O guiamento por voz fala no idioma escolhido quando o dispositivo tem uma voz instalada para ele. Caso contrário, a narração do SDK fica desligada naquela sessão. O TalkBack continua anunciando as instruções no idioma escolhido.

Android App Bundle

Ao publicar o aplicativo como Android App Bundle, a Google Play instala apenas os idiomas configurados no dispositivo do usuário. Se o seu aplicativo escolher um idioma diferente do idioma do dispositivo, desative a divisão por idioma no build.gradle do módulo do aplicativo:

android {
    bundle {
        language {
            enableSplit = false
        }
    }
}

Quando as traduções do idioma escolhido não estão instaladas, o SDK é exibido em português e registra um aviso nos logs.

O Objeto VisualConfiguration

Parâmetro	Função	Obrigatório
.setOnboardingDrawable(int onboarding_drawable, int onboarding_width)	Utilizado para configurar a imagem mostrada para o usuário na tela de onboarding do SDK. O parâmetro onboarding_drawable deve referenciar o id da imagem a ser mostrada e onboarding_width é o tamanho desejado de exibição desta imagem.	Não.
.setDocumentFullDrawable(int documentfull_drawable, int documentfull_width)	Utilizado para configurar a imagem mostrada para o usuário na tela de captura de CNH inteira do SDK. O parâmetro documentfull_drawable deve referenciar o id da imagem a ser mostrada e documentfull_width é o tamanho desejado de exibição desta imagem.	Não.
.setDocumentFrontDrawable(int documentfront_drawable, int documentfront_width)	Utilizado para configurar a imagem mostrada para o usuário na tela de captura de CNH e RG frente do SDK. O parâmetro documentfront_drawable deve referenciar o id da imagem a ser mostrada e documentfront_width é o tamanho desejado de exibição desta imagem.	Não.
.setDocumentBackDrawable(int documentback_drawable, int documentback_width)	Utilizado para configurar a imagem mostrada para o usuário na tela de captura de CNH e RG verso do SDK. O parâmetro documentback_drawable deve referenciar o id da imagem a ser mostrada e documentback_width é o tamanho desejado de exibição desta imagem.	Não.
.setButtonBorderSize(int border_size)	Utilizado para configurar a largura de borda dos botões do SDK.	Não. O padrão é 1.
.setButtonShadow(boolean button_shadow)	Quando setado para false remove o efeito de sombra, padrão no android, utilizado pelos botões do SDK.	Não. O padrão é true.

O Objeto TextConfiguration

Parâmetro	Função	Obrigatório
.setCustomText(CustomLabel label, String text)	Utilizado para configurar os textos mostrados para o usuário na tela de onboarding do SDK	Não.