GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
Um builder para GetGoogleIdOption.
Resumo
Construtores públicos |
|---|
Builder() |
Métodos públicos |
|
|---|---|
final @NonNull GetGoogleIdOption.Builder |
associateLinkedAccounts(Define se é necessário oferecer suporte ao login usando Contas do Google vinculadas às contas dos usuários. |
final @NonNull GetGoogleIdOption |
build() |
final @NonNull GetGoogleIdOption.Builder |
setAutoSelectEnabled(boolean autoSelectEnabled)Define o comportamento de seleção automática na solicitação. |
final @NonNull GetGoogleIdOption.Builder |
Define as declarações a serem incluídas no token de ID do Google. |
final @NonNull GetGoogleIdOption.Builder |
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)Define se o usuário só pode selecionar entre as Contas do Google que já estão autorizadas a fazer login no seu aplicativo. |
final @NonNull GetGoogleIdOption.Builder |
setHostedDomainFilter(String hostedDomainFilter)Define o filtro de domínio hospedado para restringir o Google Sign-In a contas em um domínio específico do Google Workspace. |
final @NonNull GetGoogleIdOption.Builder |
Define o valor único a ser usado ao gerar um token de ID do Google. |
final @NonNull GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)Define se um número de telefone verificado será solicitado durante as inscrições. |
final @NonNull GetGoogleIdOption.Builder |
setServerClientId(@NonNull String serverClientId)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
Métodos públicos
associateLinkedAccounts
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
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 | |
|---|---|
@NonNull String linkedServiceId |
ID do serviço usado ao vincular contas a uma Conta do Google. |
List<@NonNull String> idTokenDepositionScopes |
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. |
setAutoSelectEnabled
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
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
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
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.
setFilterByAuthorizedAccounts
public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)
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 | |
|---|---|
boolean filterByAuthorizedAccounts |
se o usuário só pode selecionar entre as Contas do Google que já estão autorizadas a fazer login no seu aplicativo |
setHostedDomainFilter
public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)
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 | |
|---|---|
String hostedDomainFilter |
o domínio a ser filtrado (por exemplo, "example.com") |
setNonce
public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)
Define o valor único a ser usado ao gerar um token de ID do Google.
| Parâmetros | |
|---|---|
String nonce |
o nonce a ser usado durante a geração do token de ID |
setRequestVerifiedPhoneNumber
public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)
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
public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)
Define o ID do cliente do servidor para usar como público-alvo dos tokens de ID do Google gerados durante o login.