Credenciais de classe
- java.lang.Object
-
- io.realm.mongodb.Credentials
-
public class Credentials extends Object
As credenciais representam um login com um determinado provedor de login e são usadas pelo MongoDB Realm para verificar o usuário e conceder acesso. O fornecedorCredentials.Provider.EMAIL_PASSWORD
está habilitado por padrão. Todos os outros provedores devem estar habilitados no MongoDB Realm para funcionar.Observe que os usuários que desejam se conectar usando e-mail/senha devem se registrar primeiro usando
As credenciais são usadas da seguinte maneira:EmailPasswordAuth.registerUser(String, String)
.// Example App app = new App("app-id"); Credentials credentials = Credentials.emailPassword("email", "password"); User user = app.loginAsync(credentials, new App.Callback<User>() { \@Override public void onResult(Result<User> result) { if (result.isSuccess() { handleLogin(result.get()); } else { handleError(result.getError()); } } )); }
- Veja também:
- Provedores de autenticação
-
-
Resumo da classe aninhada
Classes agrupadas Modificador e tipo classe Descrição static class
Credentials.Provider
Esta enumeração contém a lista de fornecedores de identidade suportados pelo MongoDB Realm.
-
Resumo do método
Todos os métodos Métodos estáticos Métodos de instância Métodos concretos Métodos obsoletos Modificador e tipo Método Descrição static Credentials
anonymous()
Cria credenciais representando um usuário anônimo.static Credentials
apiKey(String key)
Cria credenciais representando um login usando uma chave de API do usuário.static Credentials
apple(String idToken)
Cria credenciais que representam um login usando um token de ID Apple.String
asJson()
Retorna o objeto de credenciais serializado como uma string JSON.static Credentials
customFunction(Document arguments)
Cria credenciais representando uma função remota do MongoDB Realm usando umaDocument
que será analisada como um argumento para a função remota, portanto, as chaves devem corresponder ao formato e aos nomes que a função espera.static Credentials
emailPassword(String email, String password)
Cria credenciais representando um login usando e-mail e senha.static Credentials
facebook(String accessToken)
Cria credenciais representando um login usando um token de acesso do Facebook.Credentials.Provider
getIdentityProvider()
Retorna o provedor de identidade usado para autenticar.static Credentials
google(String authorizationCode)
Obsoleto.Em vez disso, usegoogle(String, GoogleAuthType)
.static Credentials
google(String token, GoogleAuthType type)
Cria credenciais representando um login usando um token de acesso do Google de um determinadoGoogleAuthType
.static Credentials
jwt(String jwtToken)
Cria credenciais representando um login usando um JWT Token.
-
-
-
Detalhes do método
-
Anônimo
public static Credentials anonymous()
Cria credenciais representando um usuário anônimo.Desconectar o usuário novamente significa que os dados são perdidos sem meios de recuperação e não é possível compartilhar os detalhes do usuário entre dispositivos.
O usuário anônimo deve estar vinculado a outro usuário real para preservar os dados após sair.
- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
apiKey
public static Credentials apiKey(String key)
Cria credenciais representando um login usando uma chave de API do usuário.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
key
- a chave de API a ser usada para login.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
Apple
public static Credentials apple(String idToken)
Cria credenciais que representam um login usando um token de ID Apple.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
idToken
- o token de ID gerado ao usar seu login da Apple.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
Função personalizada
public static Credentials customFunction(Document arguments)
Cria credenciais representando uma função remota do MongoDB Realm usando umaDocument
que será analisada como um argumento para a função remota, portanto, as chaves devem corresponder ao formato e aos nomes que a função espera.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
arguments
- documento contendo os argumentos da função.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
emailPassword
public static Credentials emailPassword(String email, String password)
Cria credenciais representando um login usando e-mail e senha.- Parâmetros:
email
- e-mail do usuário que está fazendo login.password
- senha do usuário que faz login.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
Facebook
public static Credentials facebook(String accessToken)
Cria credenciais representando um login usando um token de acesso do Facebook.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
accessToken
- o token de acesso retornado ao fazer login no Facebook.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
Google
public static Credentials google(String token, GoogleAuthType type)
Cria credenciais representando um login usando um token de acesso do Google de um determinadoGoogleAuthType
.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
token
- o token de acesso retornado ao fazer login no Google.type
- o tipo de token de acesso- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
Google
@Deprecated public static Credentials google(String authorizationCode)
Obsoleto.Em vez disso, usegoogle(String, GoogleAuthType)
.Cria credenciais representando um login usando um token de acesso do GoogleGoogleAuthType.AUTH_CODE
.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
authorizationCode
- o código de autorização retornado ao fazer login no Google.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
jwt
public static Credentials jwt(String jwtToken)
Cria credenciais representando um login usando um JSON web token Token. Esse token é normalmente gerado após um fluxo de login OAuth2 personalizado.Esse provedor deve estar habilitado no MongoDB Realm para funcionar.
- Parâmetros:
jwtToken
- o token JSON web token retornado após um login personalizado em outro serviço.- Retorna:
- um conjunto de credenciais que pode ser usado para fazer login no MongoDB Realm usando
App.loginAsync(Credentials, App.Callback)
.
-
getIdentityProvider
public Credentials.Provider getIdentityProvider()
Retorna o provedor de identidade usado para autenticar.- Retorna:
- o provedor identifica as credenciais escolhidas.
-
asJson
public String asJson()
Retorna o objeto de credenciais serializado como uma string JSON.- Retorna:
- uma string serializada JSON do objeto de credenciais.
-
-