Doc Core

📝

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.

💡

Nota

1. O parâmetro showFeedback é opcional e possui true como valor padrão;
2. 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:

Builder de customização

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

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:

⚠️

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:

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