Pular para o conteúdo principal

QITechIosOcrConfiguration

let onboardingTextConfiguration = OnboardingTextConfiguration(
onboardingTitle: "Conselhos relevantes",
onboardingFirstLabel: "Esteja em um local iluminado",
onboardingSecondLabel: "Tire o documento do envelope",
onboardingThirdLabel: "Enquadre o documento nas marcas"
)

let ocrConfig = QITechIosOcrConfiguration(
environment: QITechIosOcrEnvironment.sandbox,
mobileToken: "41fb4755-9bcf-4ae3-b981-b6009e51ce4a",
sessionId: "288eb399-4936-4133-ab2c-5611d6e5bb7a",
documentSteps: documentSteps,
fontColor: "#337DFF",
backgroundColor: "#C9CCD3",
fontFamily: .open_sans,
showIntroductionScreens: true,
showSuccessScreen: false,
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: "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 = QITechIosOcrConfiguration(environment: QITechIosOcrEnvironment.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 QITechIosOcrConfiguration é 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 do SDK.

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

nometipodescrição
environmentQITechIosOcrEnvironment(obrigatório) Enumerador que descreve o ambiente.
mobileTokenstring(obrigatório) Token enviado pela QI Tech para autenticação do 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.
documentStepsQITechIosOcrDocumentFlow(obrigatório) Enumerador que descreve qual fluxo de validação será seguido, definindo qual documento e qual ordem de captura de imagem será realizado.
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.
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.
audioConfigurationAudioConfiguration(opcional) Configura o guiamento por voz do SDK, que narra as instruções de captura em tempo real. As configurações aceitas são: Enable, que exibe o botão de ligar/desligar áudio com a narração iniciando desligada; Disable, que desativa a narração e oculta o botão; e Accessibility, que exibe o botão com a narração iniciando ligada quando o dispositivo possui recursos de acessibilidade ativos. Com o VoiceOver ativo, as instruções completas são entregues pelo próprio leitor de telas. Caso não seja informada o padrão é Disable.
languageString(opcional) 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. 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.current.identifier.
  • 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 VoiceOver continua anunciando as instruções no idioma escolhido.

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;