Selphid Configuración

Listado de parámetros de configuración del componente

resourcesPath

type: string

Establece el nombre del archivo de recursos que utilizará el widget para su configuración gráfica. Éste archivo es personalizable y se encuentra en el complemento en la carpeta src/main/assets para Android y en ios/Frameworks y de la carpeta Resources para iOS. Su instalación es transparente para el usuario, simplemente se agregará a los proyectos de las respectivas plataformas durante la instalación del complemento. Véase ejemplo de implementación:

resourcesPath: "fphi-selphid-widget-resources-sdk.zip"

3.2 ShowResultAfterCapture

type: boolean

Indica si mostrar o no una pantalla con la imagen capturada del documento después del proceso de análisis. En esta pantalla se le da al usuario la posibilidad de repetir el proceso de captura si la imagen que se obtuvo del documento no fuera correcta. Véase ejemplo de implementación:

showResultAfterCapture: false

3.3 ScanMode

type: SelphIDScanMode

Este enumerado se define en la clase SelphIDScanMode, dentro del fichero fphi_sdkmobile_selphid_scan_mode.dart. Indica el modo de escaneo OCR de los documentos. Dependiendo de la elección, se escanearán y buscarán varios tipos de documentos o uno en concreto. Este modo puede ser de tres tipos:

  • SelphIDScanMode.CAP_MODE_GENERIC: El modo genérico que permite escanear cualquier tipo de documento independiente del país o el tipo de documento. El resultado de este modo no es tan preciso como los siguientes pero permite escanear varios documentos estándar.

  • SelphIDScanMode.CAP_MODE_SEARCH: El modo de búsqueda permitirá utilizar una whitelist y blacklist, y buscará en los documentos que cumplan dichas condiciones. Estas condiciones se indican en la variable "specificData". De este modo se permite realizar la búsqueda acotando el número de plantillas, y haciendo que la búsqueda sea mucho más afinada que en el caso genérico.

  • SelphIDScanMode.CAP_MODE_SPECIFIC: Búsqueda de un documento específico. Estas condiciones se indican en la propiedad "specificData" que se muestra en lo sucesivo.

Véase ejemplo de implementación:

scanMode: SelphIDScanMode.CAP_MODE_SEARCH;

3.4 SpecificData

type: string

Esta propiedad permite definir qué documentos se escanearán durante el proceso, en caso de declarar el modo de escaneo (scanMode) a GenericMode, SpecificMode o SearchMode.

Un ejemplo de configuración que permita escanear todos los documentos de nacionalidad española sería el siguiente:

3.5 FullScreen

type: boolean

Establece si se desea que el widget se arranque en modo pantalla completa, ocultando el status bar.

3.6 Locale

type: string

Es un string que permite cambiar la localización y el idioma del widget. Ejemplos de valores que pueden tener son los siguientes:

  • “es” para español.

  • “en” para inglés.

  • “fr” para francés.

En definitiva, dependerá del nombre que aparezca en el fichero strings.xml del lenguaje que se desee seleccionar (strings-es.xml, strings-en.xml, strings-fr.xml).

En el zip de recursos, el cual se encuentra dentro de la carpeta strings, se pueden añadir los ficheros strings-xx.xml correspondientes a cada localización que se requiere incorporar en el widget.

SelphIDDocumentType

type: string

Este enumerado se define en el fichero fphi_sdkmobile_selphid_document_type.dart. Especificado en el enum SelphIDDocumentType:

  • DT_IDCard: Establece que se capturarán documentos de identidad o tarjetas.

  • DT_Passport: Establece que se capturarán pasaportes. (Adicionamente habrá que setear el scanMode en SelphIDScanMode.Generic)

  • DT_DriverLicense: Establece que se capturarán licencias de conducir.

  • DT_ForeignCard: Establece que se capturarán tarjetas de identidad de Extranjeros.

  • DT_Custom: Engloba documentos que no se encuentran en ninguna de las categorías anteriores.

tokenImageQuality

type: double

Especifica la calidad de compresión del tokenFaceImage.

generateRawImages

type: boolean

Esta propiedad configura el widget para devolver la imagen completa de la cámara que se utilizó para capturar el documento:

  • rawFrontDocument: Imagen frontal del documento sin procesar.

  • rawBackDocument: Imagen trasera del documento sin procesar.

  • tokenRawFrontDocument: Tokenizado de la imagen frontal del documento sin procesar.

  • tokenRawBackDocument: Tokenizado de la imagen trasera del documento sin procesar.

timeout

type: SelphIDTimeout

Es un enumerado que define el timeout de la captura de un lado del documento. Tiene 4 posibles valores:

  • SelphIDTimeout.Short: 15 segundos.

  • SelphIDTimeout.Medium: 20 segundos.

  • SelphIDTimeout.Long: 25 segundos.

  • SelphIDTimeout.VeryLong: 60 segundos.

tutorialOnly

type: boolean

Establece si se desea lanzar el widget en modo Tutorial. Esto permite mostrar el tutorial del widget previo, pero SIN realizar el proceso posterior de captura. Útil en caso de que se desee mostrar el tutorial de forma aislada.

videoFilename

type: string

Esta es una propiedad avanzada, y que en la mayoría de casos no es necesario modificar. Su uso incorrecto puede provocar un funcionamiento incorrecto del componente.

Establece la ruta absoluta del nombre del archivo en el que se grabará un video del proceso de captura. La aplicación es la responsable de solicitar los permisos necesarios al teléfono en caso de que esa ruta requiera de permisos adicionales. El componente, por defecto, no realizará ningún proceso de grabación a menos que se especifique una ruta de archivo mediante este método.

documentModels

type: string

Esta es una propiedad avanzada, y en la mayoría de casos de uso no es necesario modificarla. Su uso incorrecto puede provocar un funcionamiento incorrecto del componente.

Esta propiedad permite, mediante una cadena en formato xml, configurar modelado de los documentos que el widget va a tratar de capturar. La definición de este modelado se puede encontrar, por defecto, en un .xml de modelos dentro del .zip de recursos. Con esta propiedad se permite a una aplicación actualizar y sustituir, en ejecución, los modelados de los documentos actuales del componente.

translationsContent

type: string

Esta es una propiedad avanzada, y en la mayoría de casos de uso no es necesario modificarla. Su uso incorrecto puede provocar un funcionamiento incorrecto del componente.

Esta propiedad permite, mediante una cadena en formato xml, configurar la localización actual del widget. La definición de este modelado se puede encontrar, por defecto, en una carpeta interna de traducciones dentro del .zip de recursos. Con esta propiedad se permite a una aplicación actualizar y sustituir, en ejecución, la localización actual del componente.

viewsContent

type: string

Esta es una propiedad avanzada, y en la mayoría de casos de uso no es necesario modificarla. Su uso incorrecto puede provocar un funcionamiento incorrecto del componente.

Esta propiedad permite, mediante una cadena en formato xml, configurar las vistas del componente actual. La definición de este modelado se puede encontrar, por defecto, en un fichero llamado widget.xml dentro del .zip de recursos. Con esta propiedad se permite a una aplicación actualizar y sustituir, en ejecución, el diseño de las pantallas internas del componente.

showPreviousTip

type: boolean

Muestra una pantalla de prelanzamiento con información sobre el proceso a realizar y un botón de inicio.

PreviousSelphid - Personalización del ComponenteNextNfc

Last updated