SelphID Configuração
Lista de parâmetros de configuração do componente
resourcesPath
type: string
Define o nome do arquivo de recursos que o widget utilizará para sua configuração gráfica. Este arquivo é personalizável e se encontra no complemento, na pasta src/main/assets para Android e em ios/Frameworks e da pasta Resources para iOS. Sua instalação é transparente para o usuário, simplesmente será adicionada aos projetos das respectivas plataformas durante a instalação do complemento. Veja exemplo de implementação:
resourcesPath: "fphi-selphid-widget-resources-sdk.zip"3.2 ShowResultAfterCapture
type: boolean
Indica se deve mostrar ou não uma tela com a imagem capturada do documento após o processo de análise. Nessa tela, é dada ao usuário a possibilidade de repetir o processo de captura se a imagem obtida do documento não estiver correta. Veja exemplo de implementação:
showResultAfterCapture: false3.3 ScanMode
type: SelphIDScanMode
Este enumerado é definido na classe SelphIDScanMode, dentro do arquivo fphi_sdkmobile_selphid_scan_mode.dart. Indica o modo de escaneamento OCR dos documentos. Dependendo da escolha, serão escaneados e buscados vários tipos de documentos ou um específico. Esse modo pode ser de três tipos:
SelphIDScanMode.CAP_MODE_GENERIC: O modo genérico que permite escanear qualquer tipo de documento, independente do país ou do tipo de documento. O resultado desse modo não é tão preciso quanto os seguintes, mas permite escanear vários documentos padrão.
SelphIDScanMode.CAP_MODE_SEARCH: O modo de busca permitirá utilizar uma whitelist e blacklist, e buscará nos documentos que atendam a essas condições. Essas condições são indicadas na variável "specificData". Desse modo, é possível realizar a busca restringindo o número de templates, tornando a busca muito mais precisa do que no caso genérico.
SelphIDScanMode.CAP_MODE_SPECIFIC: Busca de um documento específico. Essas condições são indicadas na propriedade "specificData" mostrada a seguir.
Veja exemplo de implementação:
scanMode: SelphIDScanMode.CAP_MODE_SEARCH;3.4 SpecificData
type: string
Esta propriedade permite definir quais documentos serão escaneados durante o processo, caso seja declarado o modo de escaneamento (scanMode) como GenericMode, SpecificMode ou SearchMode.
Um exemplo de configuração que permita escanear todos os documentos de nacionalidade espanhola seria o seguinte:
3.5 FullScreen
type: boolean
Define se deseja que o widget seja iniciado em modo de tela cheia, ocultando a barra de status.
3.6 Locale
type: string
É uma string que permite alterar a localização e o idioma do widget. Exemplos de valores que pode ter são os seguintes:
“es” para espanhol.
“en” para inglês.
“fr” para francês.
Em suma, dependerá do nome que aparecer no arquivo strings.xml do idioma que se deseja selecionar (strings-es.xml, strings-en.xml, strings-fr.xml).
No zip de recursos, que se encontra dentro da pasta strings, podem ser adicionados os arquivos strings-xx.xml correspondentes a cada localização que se deseja incorporar ao widget.
SelphIDDocumentType
type: string
Este enumerado é definido no arquivo fphi_sdkmobile_selphid_document_type.dart. Especificado no enum SelphIDDocumentType:
DT_IDCard: Define que serão capturados documentos de identidade ou cartões.
DT_Passport: Define que serão capturados passaportes. (Adicionalmente será necessário definir o scanMode como SelphIDScanMode.Generic)
DT_DriverLicense: Define que serão capturadas carteiras de motorista.
DT_ForeignCard: Define que serão capturadas carteiras de identidade de estrangeiros.
DT_Custom: Engloba documentos que não se encontram em nenhuma das categorias anteriores.
tokenImageQuality
type: double
Especifica a qualidade de compressão do tokenFaceImage.
generateRawImages
type: boolean
Esta propriedade configura o widget para devolver a imagem completa da câmera que foi utilizada para capturar o documento:
rawFrontDocument: Imagem frontal do documento sem processamento.
rawBackDocument: Imagem traseira do documento sem processamento.
tokenRawFrontDocument: Tokenizado da imagem frontal do documento sem processamento.
tokenRawBackDocument: Tokenizado da imagem traseira do documento sem processamento.
tempo limite
type: SelphIDTimeout
É um enumerado que define o timeout da captura de um lado do documento. Tem 4 valores possíveis:
SelphIDTimeout.Short: 15 segundos.
SelphIDTimeout.Medium: 20 segundos.
SelphIDTimeout.Long: 25 segundos.
SelphIDTimeout.VeryLong: 60 segundos.
tutorialOnly
type: boolean
Define se deseja iniciar o widget em modo Tutorial. Isso permite mostrar o tutorial prévio do widget, mas SEM realizar o processo posterior de captura. Útil caso se deseje mostrar o tutorial de forma isolada.
videoFilename
type: string
Esta é uma propriedade avançada e, na maioria dos casos, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
Define o caminho absoluto do nome do arquivo no qual será gravado um vídeo do processo de captura. A aplicação é responsável por solicitar as permissões necessárias ao telefone caso esse caminho exija permissões adicionais. O componente, por padrão, não realizará nenhum processo de gravação a menos que seja especificado um caminho de arquivo por meio deste método.
documentModels
type: string
Esta é uma propriedade avançada e, na maioria dos casos de uso, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
Esta propriedade permite, por meio de uma cadeia no formato xml, configurar o modelamento dos documentos que o widget tentará capturar. A definição desse modelamento pode ser encontrada, por padrão, em um .xml de modelos dentro do .zip de recursos. Com esta propriedade, permite-se a uma aplicação atualizar e substituir, em execução, os modelamentos dos documentos atuais do componente.
translationsContent
type: string
Esta é uma propriedade avançada e, na maioria dos casos de uso, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
Esta propriedade permite, por meio de uma cadeia no formato xml, configurar a localização atual do widget. A definição dessa modelagem pode ser encontrada, por padrão, em uma pasta interna de traduções dentro do .zip de recursos. Com esta propriedade, permite-se a uma aplicação atualizar e substituir, em execução, a localização atual do componente.
viewsContent
type: string
Esta é uma propriedade avançada e, na maioria dos casos de uso, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
Esta propriedade permite, por meio de uma cadeia no formato xml, configurar as views do componente atual. A definição desse modelamento pode ser encontrada, por padrão, em um arquivo chamado widget.xml dentro do .zip de recursos. Com esta propriedade, permite-se a uma aplicação atualizar e substituir, em execução, o layout das telas internas do componente.
showPreviousTip
type: boolean
Mostra uma tela de pré-lançamento com informações sobre o processo a ser realizado e um botão de início.
Atualizado