Referências
Este guia faz referência aos métodos e objetos de erro do SDK iOS.
CUSTOMIZAÇÕES
O sdk 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 getColorSilhouetteSuccess()
Método utilizado para customizar a cor de sucesso da silhueta.
Método getColorSilhouetteError()
Método utilizado para customizar a cor de erro 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 getColorTextPopupError()
Método utilizado para customizar a cor de texto e ícones do popup.
Método getColorBackgroundPopupError()
Método utilizado para customizar a cor de fundo 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.
Método getImageIconPopupError()
Método utilizado para customizar o ícone do Popup de erro, exibido quando a face é posicionada de forma incorreta no frame de captura.
Método getProgressBarColor()
(opcional)
Método opcional utilizado para customizar a cor do ícone de loading da camera Liveness com interação. Caso não implementado getColorBoxMessage() é ultilizado.
Método getCancelButtonIconColor()
(opcional)
Método opcional utilizado para customizar a cor do ícone de cancelar da camera Liveness com interação. Caso não implementado getColorBackgroundTakePictureButton() é ultilizado.
EXEMPLOS DE UTILIZAÇÃO
A seguir alguns exemplos de como você pode chamar os métodos acima em seu projeto.
- Objective-C
- Swift
.h:
#import "AcessoBioThemeDelegate.h"
@interface ViewController : UIViewController {
@end
.m:
#import "ViewController.h"
#import <AcessoBio/AcessoBio.h>
@interface ViewController ()
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
unicoCheck = [[AcessoBioManager alloc]initWithViewController:self];
}
- (id)getColorBackground {
code
}
- (id)getColorBackgroundBottomDocument {
code
}
- (id)getColorBackgroundButtonPopupError {
code
}
- (id)getColorBackgroundPopupError {
code
}
- (id)getColorBackgroundTakePictureButton {
code
}
- (id)getColorBoxMessage {
code
}
- (id)getColorIconTakePictureButton {
code
}
- (id)getColorSilhouetteError {
code
}
- (id)getColorSilhouetteSuccess {
code
}
- (id)getColorTextBottomDocument {
code
}
- (id)getColorTextButtonPopupError {
code
}
- (id)getColorTextMessage {
code
}
- (id)getColorTextPopupError {
code
}
- (id) getProgressBarColor {
code
}
- (id) getCancelButtonIconColor {
code
}
@end
import UIKit
import AcessoBio
class ViewController: UIViewController, AcessoBioManagerDelegate, AcessoBioThemeDelegate {
var unicoCheck: AcessoBioManager!
override func viewDidLoad() {
super.viewDidLoad()
unicoCheck = AcessoBioManager(viewController: self)
unicoCheck.setTheme(self)
}
func getColorBackground() -> Any! {
code
}
func getColorBoxMessage() -> Any! {
code
}
func getColorTextMessage() -> Any! {
code
}
func getColorBackgroundPopupError() -> Any! {
code
}
func getColorTextPopupError() -> Any! {
code
}
func getColorBackgroundButtonPopupError() -> Any! {
code
}
func getColorTextButtonPopupError() -> Any! {
code
}
func getColorBackgroundTakePictureButton() -> Any! {
code
}
func getColorIconTakePictureButton() -> Any! {
code
}
func getColorBackgroundBottomDocument() -> Any! {
code
}
func getColorTextBottomDocument() -> Any! {
code
}
func getColorSilhouetteSuccess() -> Any! {
code
}
func getColorSilhouetteError() -> Any! {
code
}
func getProgressBarColor() -> Any! {
code
}
func getCancelButtonIconColor() -> Any! {
code
}
}
TEMPOS DE SESSÃO
O tempo máximo de captura ao utilizar a detecção da face (smart câmera) é de 13 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. ( TimeoutToFaceInference )
Configurando os tempos de sessão
É possível alterar o tempo máximo de sessão do seu usuário ao utilizar a funcionalidade de detecção da face (Smart Camera). Para isto, através do builder, é disponibilizado o método setTimeoutSession
:
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ê poderá apresentar alguma mensagem personalizável ou instrução ao usuário. O valor padrão é de 60 segundos e seu valor mínimo é de 40 segundos.
Exemplos de utilização
- Objective-C
- Swift
#import "ViewController.h"
#import <AcessoBio/AcessoBio.h>
@interface ViewController ()
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
unicoCheck = [[AcessoBioManager alloc]initWithViewController:self];
[unicoCheck setTimeoutSession:50];
}
import UIKit
import AcessoBio
class ViewController: UIViewController, AcessoBioManagerDelegate {
var unicoCheck: AcessoBioManager!
override func viewDidLoad() {
super.viewDidLoad()
unicoCheck = AcessoBioManager(viewController: self)
unicoCheck.setTimeoutSession(50)
}
}
OBJETO ErrorBio
Este objeto é retornado sempre que ocorre um erro no SDK iOS.
MÉTODOS DISPONÍVEIS
Método utilizado para obter o código de erro ocorrido:
getCode()
Método utilizado para obter a descrição de erro ocorrido:
getDescription()
É disponibilizado a seguir a lista de possíveis códigos de erro do SDK iOS:
CÓDIGO | DESCRIÇÃO |
---|---|
73000 | The Session was cancelled because of an unknown and unexpected error. The Unico Check SDK leverages a variety of iOS APIs including camera, storage, security, networking, and more. This return value is a catch-all for errors experienced during normal usage of these APIs. |
73001 | Context invalid |
73003 | The API version needs to be 11 or newer. |
73006 | Unable to open camera on emulators |
73100 | Unable to connect to internet |
73200 | Could not find the unico_sdk json file |
73202 | Unable to load unico_sdk json file |
73203 | Unable to load AcessoBioConfigDataSource |
73204 | Unable to initialize the SDK, please configure the environment on setEnviroment method of build. |
73300 | Unable to get unico authentication object |
73301 | Unable to parse unico authentication object |
73302 | Could not find the unico 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 developer for specific unsuccess reasons. |
73706 | The camera access is prevented because either the user has explicitly denied permission or the user's device is configured to not allow access by a device policy. |
73707 | The Session was cancelled due to the app being terminated, put to sleep, an OS notification, or the app was placed in the background. |
73708 | The Session was cancelled because the device is in landscape mode. The user experience of devices in these orientations is poor and thus portrait is required. |
73709 | The Session was cancelled because the device is in reverse portrait mode. The user experience of devices in these orientations is poor and thus portrait is required. |
73710 | The Session was cancelled because the user was unable to complete a Session in the default allotted time or the timeout set by the developer. |
73711 | 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 the 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, storage, security, networking, and more. This return value is a catch-all for errors experienced during normal usage of these APIs. |
73719 | The Session was cancelled because the user pressed the Get Ready screen subtext message. Note: This functionality is not available by default, and must be requested from FaceTec in order to enable it. |
73720 | The Session was not processed. |
73721 | The Session can't be performed: attempts limit exceeded. |
73722 | The Session can't be performed: face alignment timeout. |
73730 | Unable to initialize an active liveness session because of an unknown and unexpected license error. |
73731 | Unable to initialize an active liveness session because the license has expired. |
73800 | Could not encrypt response |
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.