GetGoogleIdOption.Builder

Kotlin |Java

class GetGoogleIdOption.Builder

Es un compilador para GetGoogleIdOption.

Resumen

Constructores públicos
`Builder()`

Funciones públicas
`GetGoogleIdOption.Builder`	`associateLinkedAccounts( linkedServiceId: String, idTokenDepositionScopes: List<String>? )` Establece si se admite el acceso con Cuentas de Google vinculadas a las cuentas de los usuarios.
`GetGoogleIdOption`	`build()`
`GetGoogleIdOption.Builder`	`setAutoSelectEnabled(autoSelectEnabled: Boolean)` Establece el comportamiento de selección automática en la solicitud.
`GetGoogleIdOption.Builder`	`setClaims(claims: List<Claim>)` Establece las reclamaciones que se incluirán en el token de ID de Google.
`GetGoogleIdOption.Builder`	`setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)` 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.
`GetGoogleIdOption.Builder`	`setHostedDomainFilter(hostedDomainFilter: String?)` Establece el filtro de dominio alojado para restringir el acceso con Google a las cuentas dentro de un dominio específico de Google Workspace.
`GetGoogleIdOption.Builder`	`setNonce(nonce: String?)` Establece el nonce que se usará cuando se genere un token de ID de Google.
`GetGoogleIdOption.Builder`	`setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)` Establece si se debe solicitar un número de teléfono verificado durante el registro.
`GetGoogleIdOption.Builder`	`setServerClientId(serverClientId: String)` 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

Builder()

Funciones públicas

associateLinkedAccounts

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

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
`linkedServiceId: String`	Es el ID del servicio que se usa cuando se vinculan cuentas a una cuenta de Google.
`idTokenDepositionScopes: List<String>?`	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

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

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

fun setClaims(claims: List<Claim>): GetGoogleIdOption.Builder

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
`claims: List<Claim>`	Es una lista de reclamos.

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

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
`filterByAuthorizedAccounts: Boolean`	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

fun setHostedDomainFilter(hostedDomainFilter: String?): GetGoogleIdOption.Builder

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
`hostedDomainFilter: String?`	Es el dominio por el que se filtrará (p.ej., "example.com")

setNonce

fun setNonce(nonce: String?): GetGoogleIdOption.Builder

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

Parámetros
`nonce: String?`	Es el nonce que se usará durante la generación del token de ID.

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

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
`serverClientId: String`	El ID de cliente del servidor al que se emitirá el token de ID