/ /

/ /

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm.mongodb

Credenciales de clase

Los SDK de dispositivos Atlas están obsoletos. Consulte Página de desuso para más detalles.

io.realm.mongodb

java.lang.Object

io.realm.mongodb.Credentials

Las credenciales representan un inicio de sesión con un proveedor de inicio de sesión determinado y MongoDB Realm las utiliza para verificar al usuario y otorgar acceso. El proveedor Provider.EMAIL_PASSWORD está habilitado por defecto. Todos los demás proveedores deben estar habilitados en MongoDB Realm para funcionar.

Tenga en cuenta que los usuarios que deseen iniciar sesión usando correo electrónico/contraseña deben registrarse primero utilizando EmailPasswordAuth.registerUser(String, String).

Las credenciales se utilizan de la siguiente manera:

// 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());
    }
  }
));
}

Tip

Proveedores de autenticación

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static final`	Credenciales.Proveedor

Resumen del método

Modificador y Tipo	Método y descripción
Credenciales públicas estáticas	anonymous () Crea credenciales que representan a un usuario anónimo.
Credenciales públicas estáticas	apiKey ( String key ) Crea credenciales que representan una autenticación con una clave API de usuario.
Credenciales públicas estáticas	apple ( String idToken ) Crea credenciales que representan un inicio de sesión mediante un token de ID de Apple.
cadena pública	asJson () Devuelve el objeto de credenciales serializado como una cadena json.
Credenciales públicas estáticas	customFunction ( Document arguments ) Crea credenciales que representan una función remota de MongoDB Realm usando un documento que se analizará como argumento para la función remota, por lo que las claves deben coincidir con el formato y los nombres que la función espera.
Credenciales públicas estáticas	emailPassword ( String email, String password ) Crea credenciales que representan un inicio de sesión mediante correo electrónico y contraseña.
Credenciales públicas estáticas	facebook ( String accessToken ) Crea credenciales que representan un inicio de sesión mediante un token de acceso de Facebook.
Credenciales públicas.Proveedor	getIdentityProvider () Devuelve el proveedor de identidad utilizado para autenticarse.
Credenciales públicas estáticas	google ( String authorizationCode ) Crea credenciales que representan un inicio de sesión mediante un token de acceso de Google GoogleAuthType.AUTH_CODE.
Credenciales públicas estáticas	google ( String token, GoogleAuthType type ) Crea credenciales que representan un inicio de sesión mediante un token de acceso de Google de un GoogleAuthType determinado.
Credenciales públicas estáticas	jwt ( String jwtToken ) Crea credenciales que representan un inicio de sesión mediante un token JWT.

Métodos heredados

Métodos heredados de la clase getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitjava.lang.Object:,,,,,,,,,, finalize

Detalle del método

anónimo

public static Credentials anonymous ()

Crea credenciales que representan a un usuario anónimo. Cerrar la sesión del usuario nuevamente significa que se pierden datos sin posibilidad de recuperación y no es posible compartir los detalles del usuario entre dispositivos.

El usuario anónimo debe estar vinculado a otro usuario real para preservar los datos después de cerrar la sesión.

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

clave API

public static Credentials apiKey ( String key )
Crea credenciales que representan un inicio de sesión utilizando una clave API de usuario. Este proveedor debe estar habilitado en MongoDB Realm para funcionar. Parámetros `key` - la clave API que se utilizará para iniciar sesión. Devuelve un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

manzana

public static Credentials apple (

String idToken

)

Crea credenciales que representan un inicio de sesión mediante un token de ID de Apple. Este proveedor debe estar habilitado en MongoDB Realm para funcionar.

Parámetros

idToken - el token de identificación generado al utilizar su inicio de sesión de Apple.

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

como Json

public String asJson ()
Devuelve el objeto de credenciales serializado como una cadena json. Devuelve una cadena serializada json del objeto de credenciales.

función personalizada

public static Credentials customFunction (

Document arguments

)

Crea credenciales que representan una función remota de MongoDB Realm usando un documento que se analizará como argumento para la función remota, por lo que las claves deben coincidir con el formato y los nombres que la función espera.

Este proveedor debe estar habilitado en MongoDB Realm para funcionar.

Parámetros

arguments - documento que contiene los argumentos de la función.

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

Contraseña de correo electrónico

public static Credentials emailPassword ( String email, String password )
Crea credenciales que representan un inicio de sesión mediante correo electrónico y contraseña. Parámetros `email` - correo electrónico del usuario que inicia sesión. `password` - contraseña del usuario que inicia sesión. Devuelve un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

Facebook

public static Credentials facebook (

String accessToken

)

Crea credenciales que representan un inicio de sesión mediante un token de acceso de Facebook. Este proveedor debe estar habilitado en MongoDB Realm para funcionar.

Parámetros

accessToken - el token de acceso devuelto al iniciar sesión en Facebook.

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

obtenerProveedorDeIdentidad

public Credentials.Provider getIdentityProvider ()
Devuelve el proveedor de identidad utilizado para autenticarse. Devuelve el proveedor que identifica las credenciales elegidas.

google

public static Credentials google (

String authorizationCode

)

Crea credenciales que representan un inicio de sesión mediante un token de acceso de Google GoogleAuthType.AUTH_CODE.

Este proveedor debe estar habilitado en MongoDB Realm para funcionar.

Parámetros

authorizationCode - el código de autorización devuelto al iniciar sesión en Google.

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

public static Credentials google (

String token,

GoogleAuthType type

)

Crea credenciales que representan un inicio de sesión mediante un token de acceso de Google de un GoogleAuthType determinado.

Este proveedor debe estar habilitado en MongoDB Realm para funcionar.

Parámetros

token - el token de acceso devuelto al iniciar sesión en Google.
type - el tipo de token de acceso

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

jwt

public static Credentials jwt (

String jwtToken

)

Crea credenciales que representan un inicio de sesión mediante un token JWT. Este token se genera normalmente después de un flujo de inicio de sesión OAuth2 personalizado. Este proveedor debe estar habilitado en MongoDB Realm para funcionar.

Parámetros

jwtToken - el token jwt devuelto después de un inicio de sesión personalizado en otro servicio.

Devuelve

un conjunto de credenciales que se pueden usar para iniciar sesión en MongoDB Realm mediante App.loginAsync(Credentials, App.Callback).

Volver

Escucha de autenticación

Credenciales.Proveedor