Referências do TypeScript

Tipos

CafSmartAuthResponse

Campo	Tipo	Descrição
sucesso	CafSmartAuthSuccess	Mostra quando a autenticação inteligente retorna uma captura bem-sucedida.
error	string	Mostra quando a autenticação inteligente retorna algum erro.
cancelado	booleano	Mostra quando o usuário cancela a autenticação inteligente.
pendente	CafSmartAuthPending	Mostra quando a autenticação inteligente está pendente.
isLoading	booleano	Mostra quando a autenticação inteligente está carregando.

CafSmartAuthSuccess

Campo	Tipo	Descrição
isAuthorized	booleano	Um valor booleano que indica se a autenticação inteligente é legítima.
attemptId	string	O ID da tentativa de verificação de vivacidade facial.
attestation	string	A resposta assinada que confirma que a autenticação inteligente é legítima.

CafSmartAuthPending

Campo	Tipo	Descrição
isAuthorized	booleano	Um valor booleano que indica se a autenticação inteligente é legítima.
attestation	string	A resposta assinada que confirma que a autenticação inteligente é legítima.

CafSmartAuthError

Campo	Tipo	Descrição
message	string	Uma mensagem de erro emitida pelo SDK.

CafSmartAuthCancel

Campo	Tipo	Descrição
isCancelled	booleano	Indica se o processo de autenticação inteligente foi cancelado.

CafSmartAuthLoading

Campo	Tipo	Descrição
isLoading	booleano	Indica se a autenticação inteligente está carregando.

CafSmartAuthLoaded

Campo	Tipo	Descrição
isLoaded	booleano	Indica se a autenticação inteligente foi carregada.

CafSmartAuthTheme

Campo	Tipo	Descrição	Android	iOS
cor de fundo	string	Cor de fundo da tela de autenticação.	✅	✅
textColor	string	Cor do texto principal na tela.	✅	✅
progressColor	string	Cor do indicador de progresso.	✅	✅
linkColor	string	Cor dos links clicáveis.	✅	✅
boxBackgroundColor	string	Cor de fundo dos campos de entrada.	✅	✅
boxFilledBackgroundColor	string	Cor de fundo dos campos de entrada quando preenchidos.	❌	✅
boxBorderColor	string	Cor da borda dos campos de entrada.	✅	✅
boxFilledBorderColor	string	Cor da borda dos campos de entrada quando preenchidos.	❌	✅
boxTextColor	string	Cor do texto dentro dos campos de entrada.	✅	✅

CafSmartAuthThemeConfigurator

Campo	Tipo	Descrição	Android	iOS
lightTheme	CafSmartAuthTheme	Define o tema visual da tela de autenticação no modo claro.	✅	✅
darkTheme	CafSmartAuthTheme	Define o tema visual da tela de autenticação no modo escuro.	✅	✅

CafSmartAuthSettings

Campo	Tipo	Descrição	Android	iOS
faceAuthenticationSettings	CafFaceAuthenticationSettings	Usado para alterar o filtro do SDK.	✅	✅
stage	CafStage	Usado para redirecionar o SDK para a etapa desejada na API caf.	✅	✅
emailUrl	string	Define uma URL de autenticação por e-mail. Deve usar o protocolo HTTPS.	✅	✅
phoneUrl	string	Define uma URL de autenticação por telefone. Deve usar o protocolo HTTPS.	✅	✅
theme	CafSmartAuthThemeConfigurator	Define a configuração de tema para o SDK. Personalize a aparência para os modos claro e escuro.	✅	✅

CafSmartAuthResponse

Campo	Tipo	Descrição
sucesso	CafSmartAuthSuccess	Mostra quando a autenticação inteligente retorna uma captura bem-sucedida.
error	CafSmartAuthError | null	Mostra quando a autenticação inteligente retorna um erro.
cancelado	booleano	Indica se o usuário cancelou o processo de autenticação inteligente.
pendente	CafSmartAuthPending | null	Mostra quando a autenticação inteligente está pendente.
isLoading	booleano	Indica se o processo de autenticação inteligente está sendo carregado no momento.

CafSmartAuthBridgeModuleEvents

Evento	Tipo	Descrição
CafSmartAuth_Success	CafSmartAuthSuccess	Acionado quando uma captura bem-sucedida ocorre.
CafSmartAuth_Pending	CafSmartAuthPending	Acionado quando o processo de autenticação inteligente está pendente.
CafSmartAuth_Error	CafSmartAuthError	Acionado quando ocorre um erro.
CafSmartAuth_Cancel	CafSmartAuthCancel	Acionado quando o processo é cancelado.
CafSmartAuth_Loading	CafSmartAuthLoading	Acionado quando o processo está carregando.
CafSmartAuth_Loaded	CafSmartAuthLoaded	Acionado quando o processo foi carregado.

Enumerações

CafStage

Campo	Descrição	Android	iOS
DEV	Ambiente de desenvolvimento	✅	✅
BETA	Ambiente de beta.	✅	✅
PROD	Ambiente de produção.	✅	✅

CafFilter

Campo	Descrição	Android	iOS
NATURAL	Máscara normal para vivacidade facial.	✅	✅
LINE_DRAWING	Máscara alternativa para vivacidade facial.	✅	✅