GetGoogleIdOption.Builder

public final class GetGoogleIdOption.Builder


Es un compilador para GetGoogleIdOption.

Resumen

Constructores públicos

Métodos públicos

final @NonNull GetGoogleIdOption.Builder
associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

Establece si se admite el acceso con Cuentas de Google vinculadas a las cuentas de los usuarios.

final @NonNull GetGoogleIdOption
final @NonNull GetGoogleIdOption.Builder
setAutoSelectEnabled(boolean autoSelectEnabled)

Establece el comportamiento de selección automática en la solicitud.

final @NonNull GetGoogleIdOption.Builder

Establece las reclamaciones que se incluirán en el token de ID de Google.

final @NonNull GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

Establece si solo se permitirá que el usuario seleccione entre las Cuentas de Google que ya están autorizadas para acceder a tu aplicación.

final @NonNull GetGoogleIdOption.Builder
setHostedDomainFilter(String hostedDomainFilter)

Establece el filtro de dominio alojado para restringir el acceso con Google a las cuentas dentro de un dominio específico de Google Workspace.

final @NonNull GetGoogleIdOption.Builder

Establece el nonce que se usará cuando se genere un token de ID de Google.

final @NonNull GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

Establece si se debe solicitar un número de teléfono verificado durante el registro.

final @NonNull GetGoogleIdOption.Builder
setServerClientId(@NonNull String serverClientId)

Establece el ID de cliente del servidor para usarlo como público objetivo de los tokens de ID de Google que se generan durante el acceso.

Constructores públicos

Builder

public Builder()

Métodos públicos

associateLinkedAccounts

public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

Establece si se admite el acceso con Cuentas de Google vinculadas a las cuentas de los usuarios.

Cuando se selecciona una credencial de este tipo, primero se depositará en tu servidor un token de ID de Google para la Cuenta de Google a la que está vinculada la cuenta seleccionada y, luego, se te devolverá. Al igual que con el acceso normal, tu backend podría usar el token de ID para permitir el acceso del usuario. Ten en cuenta que la deposición del token de ID solo se realizará la primera vez que se acceda con esta credencial. Los accesos posteriores no requerirán una declaración, ya que el token de ID ya se habrá asociado con la cuenta del usuario.

Parámetros
@NonNull String linkedServiceId

Es el ID del servicio que se usa cuando se vinculan cuentas a una cuenta de Google.

List<@NonNull String> idTokenDepositionScopes

Son los alcances de OAuth que Google necesitará para depositar un token de ID de Google en el servidor de backend de tu aplicación. Este campo es opcional y se puede establecer como nulo. Solo se requiere si Google necesita permisos específicos para poder depositar el token de ID.

build

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)

Establece el comportamiento de selección automática en la solicitud.

Para los usuarios que habilitan la opción, la selección automática permite que se seleccione una credencial automáticamente sin esperar una acción del usuario (como presionar el botón "Continuar"). Se puede seleccionar automáticamente una credencial si 1) solo se puede usar una credencial para acceder y 2) no es necesario realizar ninguna acción adicional para esta credencial (por ejemplo, los permisos de uso compartido de datos ya se recopilaron para una Cuenta de Google).

setClaims

public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)

Establece las reclamaciones que se incluirán en el token de ID de Google.

Para obtener una lista de los reclamos disponibles, consulta la documentación. Se ignorarán los reclamos no admitidos.

Parámetros
@NonNull List<@NonNull Claim> claims

Es una lista de reclamos.

setFilterByAuthorizedAccounts

public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

Establece si solo se permitirá que el usuario seleccione entre las Cuentas de Google que ya están autorizadas para acceder a tu aplicación. El valor predeterminado es verdadero.

Si es {@code true}, el usuario no podrá seleccionar ninguna Cuenta de Google que, de lo contrario, requeriría autorización explícita para compartir datos básicos de perfil o correo electrónico con tu aplicación. Esto puede reducir la fricción en el recorrido del usuario de acceso y garantiza que la credencial devuelta sea para un "usuario recurrente", pero limita la libertad del usuario para elegir entre todas las Cuentas de Google en el dispositivo.

Parámetros
boolean filterByAuthorizedAccounts

Si solo se permite que el usuario seleccione entre las Cuentas de Google que ya están autorizadas para acceder a tu aplicación

setHostedDomainFilter

public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)

Establece el filtro de dominio alojado para restringir el acceso con Google a las cuentas dentro de un dominio específico de Google Workspace.

Si se pasa una cadena nula o vacía, no se aplicará ningún filtro.

Parámetros
String hostedDomainFilter

Es el dominio por el que se filtrará (p.ej., "example.com")

setNonce

public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)

Establece el nonce que se usará cuando se genere un token de ID de Google.

Parámetros
String nonce

Es el nonce que se usará durante la generación del token de ID.

setRequestVerifiedPhoneNumber

public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

Establece si se debe solicitar un número de teléfono verificado durante el registro.

Para usar esta función, el campo [filterByAuthorizedAccounts] debe establecerse de forma explícita como falso, ya que esta función solo está disponible durante los registros.

setServerClientId

public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)

Establece el ID de cliente del servidor para usarlo como público objetivo de los tokens de ID de Google que se generan durante el acceso.

Parámetros
@NonNull String serverClientId

El ID de cliente del servidor al que se emitirá el token de ID