Pular para o conteúdo principal

ZaigIosFaceRecognitionConfiguration

SDK 7.0.0 e posteriores

let onboardingTextConfiguration = OnboardingTextConfiguration(
onboardingTitle: "Conselhos relevantes",
onboardingFirstLabel: "Esteja com o rosto visível",
onboardingSecondlabel: "Encaixe seu rosto no oval",
onboardingThirdLabel: "Retire acessórios que cubram o rosto"
)

let faceRecognitionConfig = ZaigIosFaceRecognitionConfiguration(
environment: ZaigIosFaceRecognitionEnvironment.sandbox,
clientSessionKey: clientSessionKey,
sessionId: "7d8c6f9a-f222-450d-9501-a07c68eb2388",
documentNumber: "123.456.789-00",
fontColor: "#337DFF",
backgroundColor: "#C9CCD3",
fontFamily: .open_sans,
showIntroductionScreens: true,
showSuccessScreen: true,
showInvalidTokenScreen: false,
audioConfiguration: AudioConfiguration.enable,
onboardingTextConfiguration: onboardingTextConfiguration,
logLevel: .debug
)
Versões anteriores à v7.0.0
let visualConfiguration = VisualConfiguration()
visualConfiguration.setOnboarding(onboardingFilePath: Bundle.main.path(forResource: "onboarding", ofType: "png")!, onboardingWidth: 200)

let textConfiguration = TextConfiguration()
textConfiguration.setCustomText(on: .onboardingTitle, text: "Para tirar uma boa foto:")
textConfiguration.setCustomText(on: .onboardingFirstLabel, text: "- Vá para um local iluminado")
textConfiguration.setCustomText(on: .onboardingSecondLabel, text: "- Retire adereços e mostre bem o rosto")
textConfiguration.setCustomText(on: .onboardingThirdLabel, text: "- Insira seu rosto na moldura, aguardando que fique verde para realizar a captura")

let faceRecognitionConfig = ZaigIosFaceRecognitionConfiguration(environment: ZaigIosFaceRecognitionEnvironment.Sandbox,
clientSessionKey: clientSessionKey,
sessionId: "7d8c6f9a-f222-450d-9501-a07c68eb2388",
backgroundColor: "#C9CCD3",
fontColor: "#337DFF",
fontFamily: .open_sans,
showIntroductionScreens: true,
showSuccessScreen: false,
showInvalidTokenScreen: true,
activeFaceLiveness: true,
audioConfiguration: AudioConfiguration.Enable,
logLevel: .debug
)

faceRecognitionConfig.setVisualConfiguration(visualConfiguration: visualConfiguration)
faceRecognitionConfig.setTextConfiguration(textConfiguration: textConfiguration)

A classe ZaigIosFaceRecognitionConfiguration é utilizada para que você possa configurar ambiente, credenciais, aspectos visuais e textuais ou seja, todas as configurações necessárias para personalização e funcionamento do SDK.

Na tabela abaixo você encontra o detalhe de todos os argumentos que devem ser utilizados na sua instanciação:

nometipodescrição
environmentZaigIosFaceRecognitionEnvironment(obrigatório) Enumerador que descreve o ambiente.
clientSessionKeystring(obrigatório) Token enviado pela API face recognition para autenticação do SDK.
sessionIdstring(opcional) ID único usado para rastrear todo fluxo percorrido pelo usuário na execução da FaceRecon através de logs. Este campo aceita até 255 caracteres.
documentNumberstring(opcional) Utilizado para identificação do usuário para anti-fraude e segurança interna
fontColorstring(opcional) Hexadecimal da cor da fonte. Caso não seja informada o padrão é #1C49A5.
backgroundColorstring(opcional) Hexadecimal da cor de fundo das telas. Caso não seja informada o padrão é #FCFCFC.
fontFamilyFontFamily(opcional) Familia da fonte. Caso não seja informada o padrão é .open_sans. Fontes disponíveis: .open_sans, .futura, .verdana, .trebuchetms, .tamilsangammn e .system_font.
showIntroductionScreensbooleano(opcional) Flag que indica se as telas de introdução, com instruções de como a foto deve ser capturada, devem ser mostradas. Caso não seja informada o padrão é true.
showSuccessScreenbooleano(opcional) Flag que indica se a tela de sucesso, com a mensagem de sucesso na captura, deve ser mostrada. Caso não seja informada o padrão é true.
showInvalidTokenScreenbooleano(opcional) Flag que indica se a tela de falha de autenticação, com a mensagem de expiração de token, deve ser mostrada. Caso não seja informada o padrão é true.
audioConfigurationAudioConfiguration(opcional) Indica se o SDK deve ou não executar áudios de indicação para o usuário. As configurações aceitas são: Enable que sempre executará os áudios de indicação, Disable que nunca executará estes áudios e Accessibility que executa os áudios caso o dispositivo do usuário possua configurações de acessibilidade ativadas.
onboardingTextConfigurationOnboardingTextConfiguration(opcional) Permite configurar os textos da tela de instruções
logLevelLogLevel(opcional) 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. Caso não seja informada o padrão é LogLevel.debug.

Na tabela abaixo você encontra todos os métodos aceitos pela instância para configuração:

aviso

DEPRECADO A PARTIR DA v7.0.0!

métodoargumentosdescrição
setVisualConfigurationvisualConfiguration : VisualConfiguration(opcional) Classe que permite a modificação das imagens exibidas durante a execução do SDK;
setTextConfigurationtextConfiguration : TextConfiguration(opcional) Classe que permite a modificação dos textos exibidos durante a execução do SDK;
setDocumentNumberUtilizado para definir o número do documento do usuário. Este campo aceita 14 caracteres do CPF formatado da seguinte maneira 000.000.000-00Sim em todas as chamadas caso use a validação 1:1 em algum momento.
setValidationUtilizado para definir se o SDK deve ou não realizar a validação 1:1 com a selfie do usuário. Na primeira sessão do usuário esta flag deve estar obrigatoriamente false. Esta função depende necessita do método setDocumentNumber preenchido.Não. O padrão é false.