Referências
Este guia referencia todos os métodos e objetos disponíveis no SDK Flutter do Unico Check.
Atualmente apenas alguns objetos e snippets de código são disponibilizados que podem ser úteis para sua integração. O objetivo é evoluir este artigo para um API reference completo.
CUSTOMIZAÇÕES
O SDK Flutter conta com métodos de customização a fim de personalizar a experiência de acordo com o identidade visual de cada cliente. Segue a lista de métodos que podem ser facilmente implementadas:
MÉTODOS DISPONÍVEIS
Método getColorSilhouetteError()
Método utilizado para customizar a cor de erro da silhueta.
Método getColorSilhouetteNeutral()
Método utilizado para customizar a cor neutra da silhueta.
Método getColorBackground()
Método utilizado para customizar a cor de fundo da silhueta.
Método getColorBoxMessage()
Método utilizado para customizar a cor de fundo da mensagem.
Método getColorTextMessage()
Método utilizado para customizar a cor de texto da mensagem.
Método getColorBackgroundPopupError()
Método utilizado para customizar a cor de fundo do popup.
Método getColorTextPopupError()
Método utilizado para customizar a cor de texto e ícones do popup.
Método getColorBackgroundButtonPopupError()
Método utilizado para customizar a cor de fundo do botão do popup.
Método getColorTextButtonPopupError()
Método utilizado para customizar a cor de texto do botão do popup.
Método getColorBackgroundTakePictureButton()
Método utilizado para customizar a cor de fundo do botão de tirar foto manualmente.
Método getColorIconTakePictureButton()
Método utilizado para customizar a cor de ícone do botão de tirar foto manualmente.
Método getColorBackgroundBottomDocument()
Método utilizado para customizar a cor de fundo do box na captura de documentos.
Método getColorTextBottomDocument()
Método utilizado para customizar a cor de texto do box na captura de documentos.
CONFIGURAÇÃO DOS TEMPOS DE SESSÃO
É possível alterar o tempo máximo de sessão do seu usuário e o tempo máximo de captura ao utilizar a funcionalidade de detecção da face (smart Camera). Para isto, através do builder, 2 métodos são disponibilizados:
Método setTimeoutSession
:
Configura o tempo máximo de sessão do seu usuário (em segundos). Caso ele ultrapasse o tempo determinado em seu processo para capturar a foto, você pode apresentar alguma mensagem personalizável ou instrução ao usuário. O valor padrão é de 40 segundos e o valor mínimo também é de 40 segundos.
Método setTimeoutToFaceInference
:
Configura o tempo máximo de captura ao utilizar a detecção da face (smart câmera) em segundos. Caso o usuário encontre alguma dificuldade para capturar a foto através da detecção de face e ultrapasse o tempo determinado em seu processo, a captura é alterada automaticamente para a manual, visando facilitar a ação para o usuário. O valor padrão é de 15 segundos e o valor mínimo é de 5 segundos.
EXEMPLOS DE UTILIZAÇÃO
- Dart
_unicoCheck
.setTimeoutSession(timeoutSession: 55);
OBJETO UnicoError
Objeto retornado sempre que ocorre um erro dentro do SDK do Unico Check. A lista dos possíveis erros e mensagens pode ser vista aqui
MÉTODOS DISPONÍVEIS
Método getCode()
:
Método utilizado para obter o código de erro ocorrido.
Método getDescription()
Método utilizado para obter a descrição do ocorrido.
CÓDIGOS DE ERRO
É disponibilizado a seguir a lista de possíveis códigos de erro do SDK Flutter:
CÓDIGO | DESCRIÇÃO |
---|---|
73001 | Context invalid |
73002 | Did not grant permission to open camera |
73003 | The lest API is 21(LOLLIPOP) |
73004 | Could not find implementation interface callback iAcessoBioSelfie |
73005 | Could not find implementation interface callback iAcessoBioDocument |
73006 | Unable to open camera on emulators |
73200 | Please inform the json file name |
73202 | Unable to parse json file |
73300 | Unable to get unico authentication object |
73301 | Unable to parse object |
73302 | Could not find the unico token |
73303 | Current host is not registered |
73400 | Could not initialize camera |
73500 | Unable to get session token, service response error |
73501 | Unable to parce object |
73502 | Could not get session token |
73701 | Could not find active liveness import |
73702 | Unable to initialize active liveness in production mode |
73703 | Unable to get active liveness session |
73704 | The user pressed the cancel button and did not complete the Session. |
73705 | The Session was not performed successfully and a FaceScan was not generated. In general, other statuses will be sent to the |
73706 | The camera access is prevented because either the user has explicitly denied permission or the user's device is configured to |
73707 | The Session was cancelled due to the app being terminated, put to sleep, an OS notification, or the app was placed in the |
73708 | The Session was cancelled because device is in landscape mode. The user experience of devices in these orientations is poor |
73709 | The Session was cancelled because device is in reverse portrait mode. The user experience of devices in these orientations is |
73710 | The Session was cancelled because the user was unable to complete a Session in the default allotted time or the timeout set |
73712 | The Session was cancelled due to memory pressure. |
73712 | The Session was cancelled because your App is not in production and requires a network connection. |
73713 | The Session was cancelled because your key needs to be validated again. |
73714 | The Session was cancelled because the developer-configured encryption key was not valid. |
73715 | The Session was cancelled because not all guidance images were configured. |
73716 | The Session was cancelled because SDK was unable to start the camera on this device. |
73717 | The Session was cancelled because the user was in a locked out state. |
73718 | The Session was cancelled because of an unknown and unexpected error. SDK leverages a variety of iOS APIs including camera, |
73719 | The Session cancelled because user pressed the Get Ready screen subtext message. Note: This functionality is not available by |
73800 | Could not build encrypted key |
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.