Skip to main content

ZaigIosOcrConfiguration


let visualConfiguration = VisualConfiguration()
visualConfiguration.setOnboarding(onboardingFilePath: Bundle.main.path(forResource: "onboarding", ofType: "png")!, onboardingWidth: 200)

let textConfiguration = TextConfiguration()
textConfiguration.setCustomText(on: .onboardingTitle, text: "Vamos começar!")
textConfiguration.setCustomText(on: .onboardingFirstLabel, text: "- Vá para um local com boa luminosidade")
textConfiguration.setCustomText(on: .onboardingSecondLabel, text: "- Retire o documento do plástico")

let ocrConfig = ZaigIosOcrConfiguration(environment: ZaigIosOcrEnvironment.Sandbox,
mobileToken: "41fb4755-9bcf-4ae3-b981-b6009e51ce4a",
sessionId: "288eb399-4936-4133-ab2c-5611d6e5bb7a",
documentSteps: documentSteps,
backgroundColor: "#C9CCD3",
fontColor: "#337DFF",
fontFamily: .open_sans,
showIntroductionScreens: true,
showSuccessScreen: false,
logLevel: .debug
)

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

A classe ZaigIosOcrConfiguration é utilizada para que você possa configurar ambiente, credenciais, aspectos visuais e textuais, e o fluxo de coleta de imagens dos documentos, ou seja, todas as configurações necessárias para personalização e funcionamento da SDK.

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

nometipodescrição
environmentZaigIosOcrEnvironment(obrigatório) Enumerador que descreve o ambiente.
mobileTokenstring(obrigatório) Token enviado pela QI Tech para autenticação da SDK.
sessionIdstring(opcional) ID único usado para rastrear todo fluxo percorrido pelo usuário na execução da OCR através de logs. Este campo aceita até 255 caracteres.
documentStepsZaigIosOcrDocumentFlow(obrigatório) Enumerador que descreve qual fluxo de validação será seguido, definindo qual documento e qual ordem de captura de imagem será realizado.
backgroundColorstring(opcional) Hexadecimal da cor de fundo das telas. Caso não seja informada o padrão é #FFFFFF.
fontColorstring(opcional) Hexadecimal da cor da fonte. Caso não seja informada o padrão é #000000.
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.
logLevelLogLevel(opcional) . Utilizado para customizar o nível de verbosidade dos logs da 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:

métodoargumentosdescrição
setVisualConfigurationvisualConfiguration : VisualConfiguration(opcional) Classe que permite a modificação das imagens exibidas durante a execução da SDK;
setTextConfigurationtextConfiguration : TextConfiguration(opcional) Classe que permite a modificação dos textos exibidos durante a execução da SDK;