GetGoogleIdOption.Builder
class GetGoogleIdOption.Builder
Un costruttore per GetGoogleIdOption.
Riepilogo
Costruttori pubblici |
|---|
Builder() |
Funzioni pubbliche |
|
|---|---|
GetGoogleIdOption.Builder |
associateLinkedAccounts(Imposta se supportare l'accesso utilizzando gli Account Google collegati agli account degli utenti. |
GetGoogleIdOption |
build() |
GetGoogleIdOption.Builder |
setAutoSelectEnabled(autoSelectEnabled: Boolean)Imposta il comportamento di selezione automatica nella richiesta. |
GetGoogleIdOption.Builder |
Imposta le rivendicazioni da includere nel token ID Google. |
GetGoogleIdOption.Builder |
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)Determina se consentire all'utente di selezionare solo gli Account Google già autorizzati ad accedere alla tua applicazione. |
GetGoogleIdOption.Builder |
setHostedDomainFilter(hostedDomainFilter: String?)Imposta il filtro del dominio ospitato per limitare l'accesso con Google agli account all'interno di un dominio Google Workspace specifico. |
GetGoogleIdOption.Builder |
Imposta il nonce da utilizzare durante la generazione di un token ID Google. |
GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)Imposta se richiedere un numero di telefono verificato durante le registrazioni. |
GetGoogleIdOption.Builder |
setServerClientId(serverClientId: String)Imposta l'ID client del server da utilizzare come pubblico per i token ID Google generati durante l'accesso. |
Costruttori pubblici
Funzioni pubbliche
associateLinkedAccounts
fun associateLinkedAccounts(
linkedServiceId: String,
idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder
Imposta se supportare l'accesso utilizzando gli Account Google collegati agli account degli utenti.
Quando viene selezionata una credenziale di questo tipo, un token ID Google per l'Account Google a cui è collegato l'account selezionato viene prima depositato sul tuo server e poi restituito. Analogamente all'accesso normale, il backend potrebbe utilizzare il token ID per consentire l'accesso dell'utente. Tieni presente che il deposito del token ID avverrà solo al primo accesso utilizzando queste credenziali. Gli accessi successivi non richiederanno una deposizione, poiché il token ID sarà già stato associato all'account dell'utente.
| Parametri | |
|---|---|
linkedServiceId: String |
ID servizio utilizzato per collegare gli account a un Account Google. |
idTokenDepositionScopes: List<String>? |
Ambiti OAuth che Google dovrà utilizzare per depositare un token ID Google nel server di backend dell'applicazione. Questo campo è facoltativo e può essere impostato su null. Obbligatorio solo se Google richiede ambiti particolari per poter depositare il token ID. |
setAutoSelectEnabled
fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder
Imposta il comportamento di selezione automatica nella richiesta.
Per gli utenti che attivano questa opzione, la selezione automatica consente di selezionare automaticamente una credenziale senza attendere un'azione dell'utente (ad esempio toccare il pulsante "Continua"). Una credenziale può essere selezionata automaticamente se 1) è possibile utilizzare una sola credenziale per l'accesso e 2) non sono necessarie ulteriori azioni per questa credenziale (ad esempio, le autorizzazioni di condivisione dei dati sono già raccolte per un Account Google).
setClaims
fun setClaims(claims: List<Claim>): GetGoogleIdOption.Builder
Imposta le rivendicazioni da includere nel token ID Google.
Per un elenco delle rivendicazioni disponibili, consulta la documentazione. Eventuali rivendicazioni non supportate verranno ignorate.
setFilterByAuthorizedAccounts
fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder
Determina se consentire all'utente di selezionare solo gli Account Google già autorizzati ad accedere alla tua applicazione. Il valore predefinito è true.
Se {@code true}, l'utente non potrà selezionare alcun Account Google che altrimenti richiederebbe un'autorizzazione esplicita per condividere i dati di base del profilo/email con la tua applicazione. In questo modo, si riducono alcuni inconvenienti nel percorso dell'utente per l'accesso e si garantisce che le credenziali restituite siano per un "utente di ritorno", ma si limita la libertà dell'utente di scegliere tra tutti gli Account Google sul dispositivo.
| Parametri | |
|---|---|
filterByAuthorizedAccounts: Boolean |
Se consentire all'utente di selezionare solo gli Account Google già autorizzati ad accedere alla tua applicazione |
setHostedDomainFilter
fun setHostedDomainFilter(hostedDomainFilter: String?): GetGoogleIdOption.Builder
Imposta il filtro del dominio ospitato per limitare l'accesso con Google agli account all'interno di un dominio Google Workspace specifico.
Il passaggio di una stringa nulla o vuota non comporterà alcun filtro.
| Parametri | |
|---|---|
hostedDomainFilter: String? |
il dominio in base al quale filtrare (ad es. "example.com") |
setNonce
fun setNonce(nonce: String?): GetGoogleIdOption.Builder
Imposta il nonce da utilizzare durante la generazione di un token ID Google.
| Parametri | |
|---|---|
nonce: String? |
il nonce da utilizzare durante la generazione del token ID |
setRequestVerifiedPhoneNumber
fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder
Imposta se richiedere un numero di telefono verificato durante le registrazioni.
Per utilizzare questa funzionalità, il campo [filterByAuthorizedAccounts] deve essere impostato in modo esplicito su false, perché questa funzionalità è disponibile solo durante le registrazioni.
setServerClientId
fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder
Imposta l'ID client del server da utilizzare come pubblico per i token ID Google generati durante l'accesso.
| Parametri | |
|---|---|
serverClientId: String |
l'ID client del server a cui verrà emesso il token ID |