Doc Core

Guia de customização de telas para o Doc Core iOS.

📝

Uso do termo Doc Core

Nesta seção, compreende-se por Doc Core o módulo Documentscopy dentro do SDK.

Além de poder usar o SDK em sua forma padrão de exibição, o SDK permite também, que as telas sejam completamente customizadas.

A customização das telas é feita por meio da criação de objetos do tipo UIView (via código ou via Interface Builder), que implementam os protocolos definidos para cada tela do fluxo apresentado pelo SDK.

💡

Elementos adicionais

Além das telas obrigatórias, a tela customizada pode conter outros elementos, apenas tomando cuidado para que estes itens adicionais não interfiram no comportamento dos elementos obrigatórios.

As telas customizadas são passadas como argumento para o construtor da classe DocumentscopyViewController.

ParâmetroDescrição
customInstructionViewObjeto contendo a customização da tela de instruções.
customViewObjeto contendo a customização da tela de captura de documento.
customLoadingViewObjeto contendo a customização da tela de processamento do documento.
customResultViewObjeto contendo a customização da tela de resultado do processamento.
customCameraPermissionViewObjeto contendo a customização da tela de permissão de câmera.

💡

Nota

Os parâmetros customInstructionView, customView, customLoadingView, customResultView e customCameraPermissionView são opcionais.

1. Tela de instruções

Parâmetro customInstructionView

Essa tela deve estar conforme com o protocolo DocumentscopyCustomInstructionView que contém as seguintes propriedades:

IdentificadorDescrição
(1) backButtonBotão para função voltar da navegação.
(2) continueButtonBotão para iniciar o fluxo de captura do documento.
DescriçãoMétodo
Método responsável por indicar o estado do loading na tela de instruções, podendo receber dois valores:
- hidden (esconder o loading);
- displayed (mostrar o loading).
changeLoadingVisibility(to:)

Builder de customização

No DocumentscopyInstructionBuilder você terá acesso a todos os elementos listados a seguir:

IdentificadorMétodo
(1) backButtonsetInstructionBackButtonIcon(_:)
setInstructionBackButtonColors(forIcon:)
setInstructionBackButtonColors(forIcon:background:border:)
(2) backgroundsetInstructionBackgroundColor(_:)
(3) bottomSheetsetInstructionBottomSheet(withColor:)
setInstructionBottomSheet(withColor:radius:)
(4) loadingsetInstructionLoadingColor(_:)
(5) titlesetInstructionTitle(withText:)
setInstructionTitle(withText:color:font:)
(6) captionsetInstructionCaption(withText:)
setInstructionCaption(withText:color:font:)
(7) docCardsetInstructionDocOptionImage(_:)
setInstructionDocOptionTitle(withText:)
setInstructionDocOptionTitle(withText:color:font:)
setInstructionDocOptionBackgroundColor(_:)
setInstructionDocOptionBorder(withColor:)
setInstructionDocOptionBorder(withColor:width:radius:)
setInstructionDocOptionIcon(_:)
setInstructionDocOptionIcon(_:color:)
(8) envCardsetInstructionEnvOptionImage(_:)
setInstructionEnvOptionTitle(withText:)
setInstructionEnvOptionTitle(withText:color:font:)
setInstructionEnvOptionBackgroundColor(_:)
setInstructionEnvOptionBorder(withColor:)
setInstructionEnvOptionBorder(withColor:width:radius:)
setInstructionEnvOptionIcon(_:)
setInstructionEnvOptionIcon(_:color:)
(9) continueButtonsetInstructionContinueButton()
setInstructionContinueButton(backgroundColor: highlightedBackgroundColor: borderColor: highlightedBorderColor: contentColor: highlightedContentColor: textColor: font:)

Código de exemplo do Builder

let customization = DocumentscopyCustomizationBuilder.builder()
    .setInstructionBackButtonIcon(UIImage(named: "back_button_icon"))
    .setInstructionBackButtonColors(
        forIcon: UIColor.red,
        background: UIColor.black,
        border: UIColor.white
    )
    .setLoadingBackgroundColor(UIColor.green)
    .setInstructionBottomSheet(withColor: UIColor.black, radius: CGFloat(5))
    .setInstructionLoadingColor(UIColor.white)
    .setInstructionTitle(
        withText: "Titulo",
        color: UIColor.black,
        font: UIFont.systemFont(ofSize: 14)
    )
    .setInstructionCaption(
        withText: "Subtitulo",
        color: UIColor.gray,
        font: UIFont.systemFont(ofSize: 12)
    )
    .setInstructionDocOptionImage(UIImage(named: "doc_option_image"))
    .setInstructionDocOptionTitle(
        withText: "Doc Option",
        color: UIColor.white,
        font: UIFont.systemFont(ofSize: 13)
    )
    .setInstructionDocOptionBackgroundColor(UIColor.red)
    .setInstructionDocOptionBorder(
        withColor: UIColor.blue,
        width: CGFloat(2),
        radius: CGFloat(3)
    )
    .setInstructionDocOptionIcon(UIImage(named: "doc_option_icon"), color: UIColor.red)
    .setInstructionEnvOptionImage(UIImage(named: "env_option_image"))
    .setInstructionEnvOptionTitle(
        withText: "Env Option",
        color: UIColor.white,
        font: UIFont.systemFont(ofSize: 13)
    )
    .setInstructionEnvOptionBackgroundColor(UIColor.red)
    .setInstructionEnvOptionBorder(
        withColor: UIColor.blue,
        width: CGFloat(2),
        radius: CGFloat(3)
    )
    .setInstructionEnvOptionIcon(UIImage(named: "env_option_icon"), color: UIColor.red)
    .setInstructionContinueButton(
        backgroundColor: UIColor.brown,
        highlightedBackgroundColor: UIColor.orange,
        borderColor: UIColor.black,
        highlightedBorderColor: UIColor.blue,
        contentColor: UIColor.red,
        highlightedContentColor: UIColor.white,
        textColor: UIColor.green,
        font: UIFont.systemFont(ofSize: 14)
    )
    .build()

2. Tela de captura de documento

Parâmetro customView

Essa tela deve estar em conformidade com o protocolo DocumentscopyCustomView que contém os seguintes métodos e propriedades:

IdentificadorDescrição
(1) backButtonBotão para fechar a tela.
(2) closeButtonBotão para fechar a tela.
(3) frontIndicatorViewElemento que indica o momento de utilizar a frente do documento.
(4) backIndicatorViewElemento que indica o momento de utilizar o verso do documento.
(5) instructionLabelTexto informativo com orientação da captura, é exibido por apenas alguns segundos.
(6) cameraPreviewNeste elemento será colocado a pré-visualização da câmera.
(7) cameraVisualizerElemento que determina onde a pré-visualização da câmera será visível.
(8) cameraMaskElemento que determina onde a camera não será visível.
(9) captureButtonBotão para capturar foto.
(10) previewImageViewElemento de imagem onde será exibida a imagem capturada para o usuário confirmar a qualidade da captura.
(11) takeNewPictureButtonBotão para o usuário capturar a foto novamente.
(12) usePictureButtonBotão para o usuário confirmar a foto capturada.
MétodoDescrição
displayConfirmationSheet(visibility:animated:)Método que indica quando o elemento de confirmação de imagem deve ou não ser mostrado, esse método possui dois parâmetros:
- visibility que indica o estado do elemento de confirmação;
- animated que indica quando é recomendado que esse comportamento seja feito com animação.
setFocus(to:animated:)Método que indica qual o indicador de face do documento deve estar em foco no momento, esse método possui dois parâmetros:
- to (focusElement) que é um enum do tipo DocumentscopyFocusIndicator que possui os valores de frontIndicator e backIndicator que representam a frente e o verso do documento respectivamente;
- animated que indica quando é recomendado que esse comportamento seja feito com animação.
setUsePictureButtonTitle(to:)Método responsável por atribuir um novo título para o botão de usar foto (usePictureButton).
Estado 01.  |  Estado 02.

Estado 01. | Estado 02.

⚠️

Importante

  1. A propriedade cameraMask assim como a cameraPreview deve possuir suas constraints de leading, trailing, bottom e top iguais a superview e não à safearea.
  2. A propriedade cameraMask deve ser adicionada após a cameraPreview.

💡

Pré-visualização da câmera

A DocumentscopyCameraPreviewView é uma classe customizada que herda de uma UIView.

3. Tela de processamento do documento

Parâmetro customLoadingView

Essa tela deve estar em conformidade com o tipo DocumentscopyCustomLoadingView que é um typealias para o tipo UIView

4. Tela de resultado do processamento

Parâmetro customResultView

Essa tela deve estar em conformidade com o protocolo DocumentscopyCustomResultView que contém os seguintes métodos e propriedades:

IdentificadorDescrição
(1) resultButtonBotão para fechar o fluxo de reconhecimento de documento.
MétodoDescrição
display(for:)Esse método recebe como parâmetro um enum do tipo DocumentscopyResultType que indica qual resultado deve ser mostrado.
Estado 01: caso de sucesso. |  Estado 02: caso de tetar novamente.  |  Estado 03: caso de erro.

Estado 01: caso de sucesso. | Estado 02: caso de tentar novamente. | Estado 03: caso de erro.

5. Tela de permissão da câmera

Parâmetro customCameraPermissionView

💡

Nota

Por se tratar de uma tela comum aos três módulos do SDK, essa tela será descrita uma única vez ao final desta página. Customização da tela de permissão de câmera