GetGoogleIdOption.Builder

Kotlin |Java

class GetGoogleIdOption.Builder

Um builder para GetGoogleIdOption.

Resumo

Construtores públicos
`Builder()`

Funções públicas
`GetGoogleIdOption.Builder`	`associateLinkedAccounts( linkedServiceId: String, idTokenDepositionScopes: List<String>? )` Define se é necessário oferecer suporte ao login usando Contas do Google vinculadas às contas dos usuários.
`GetGoogleIdOption`	`build()`
`GetGoogleIdOption.Builder`	`setAutoSelectEnabled(autoSelectEnabled: Boolean)` Define o comportamento de seleção automática na solicitação.
`GetGoogleIdOption.Builder`	`setClaims(claims: List<Claim>)` Define as declarações a serem incluídas no token de ID do Google.
`GetGoogleIdOption.Builder`	`setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)` Define se o usuário só pode selecionar entre as Contas do Google que já estão autorizadas a fazer login no seu aplicativo.
`GetGoogleIdOption.Builder`	`setHostedDomainFilter(hostedDomainFilter: String?)` Define o filtro de domínio hospedado para restringir o Google Sign-In a contas em um domínio específico do Google Workspace.
`GetGoogleIdOption.Builder`	`setNonce(nonce: String?)` Define o valor único a ser usado ao gerar um token de ID do Google.
`GetGoogleIdOption.Builder`	`setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)` Define se um número de telefone verificado será solicitado durante as inscrições.
`GetGoogleIdOption.Builder`	`setServerClientId(serverClientId: String)` Define o ID do cliente do servidor para usar como público-alvo dos tokens de ID do Google gerados durante o login.

Construtores públicos

Builder

Builder()

Funções públicas

associateLinkedAccounts

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

Define se é necessário oferecer suporte ao login usando Contas do Google vinculadas às contas dos usuários.

Quando uma credencial desse tipo é selecionada, um token de ID do Google para a Conta do Google vinculada à conta selecionada é depositado no seu servidor e depois retornado a você. Assim como no login normal, seu back-end pode usar o token de ID para fazer login do usuário. A deposição do token de ID só vai acontecer no primeiro login usando essa credencial. Os logins subsequentes não vão exigir uma declaração, já que o token de ID já terá sido associado à conta do usuário.

Parâmetros
`linkedServiceId: String`	ID do serviço usado ao vincular contas a uma Conta do Google.
`idTokenDepositionScopes: List<String>?`	Escopos do OAuth que o Google vai precisar para depositar um token de ID do Google no servidor de back-end do seu aplicativo. Isso é opcional e pode ser definido como nulo. Necessário apenas se o Google exigir escopos específicos para depositar o token de ID.

build

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

Define o comportamento de seleção automática na solicitação.

Para os usuários que ativarem a opção, a seleção automática permite que uma credencial seja selecionada automaticamente sem esperar uma ação do usuário, como tocar no botão "Continuar". Uma credencial pode ser selecionada automaticamente se 1) apenas uma credencial puder ser usada para fazer login e 2) nenhuma outra ação precisar ser realizada para essa credencial (por exemplo, as permissões de compartilhamento de dados já foram coletadas para uma Conta do Google).

setClaims

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

Define as declarações a serem incluídas no token de ID do Google.

Para uma lista de declarações disponíveis, consulte a documentação. As reivindicações não aceitas serão ignoradas.

Parâmetros
`claims: List<Claim>`	uma lista de reivindicações.

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

Define se o usuário só pode selecionar entre as Contas do Google que já estão autorizadas a fazer login no seu aplicativo. O valor padrão é true.

Se for {@code true}, o usuário não poderá selecionar nenhuma Conta do Google que, de outra forma, exigiria autorização explícita para compartilhar dados básicos de perfil/e-mail com seu aplicativo. Isso pode reduzir um pouco o atrito na jornada do usuário de login e garante que a credencial retornada seja de um "usuário recorrente", mas limita a liberdade do usuário de escolher entre todas as Contas do Google no dispositivo.

Parâmetros
`filterByAuthorizedAccounts: Boolean`	se o usuário só pode selecionar entre as Contas do Google que já estão autorizadas a fazer login no seu aplicativo

setHostedDomainFilter

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

Define o filtro de domínio hospedado para restringir o Google Sign-In a contas em um domínio específico do Google Workspace.

Passar uma string nula ou vazia não resulta em filtragem.

Parâmetros
`hostedDomainFilter: String?`	o domínio a ser filtrado (por exemplo, "example.com")

setNonce

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

Define o valor único a ser usado ao gerar um token de ID do Google.

Parâmetros
`nonce: String?`	o nonce a ser usado durante a geração do token de ID

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

Define se um número de telefone verificado será solicitado durante as inscrições.

Para usar esse recurso, o campo [filterByAuthorizedAccounts] precisa ser definido explicitamente como "false", porque ele só está disponível durante as inscrições.

setServerClientId

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

Define o ID do cliente do servidor para usar como público-alvo dos tokens de ID do Google gerados durante o login.

Parâmetros
`serverClientId: String`	o ID do cliente do servidor para o qual o token de ID será emitido