GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
Kreator dla GetGoogleIdOption.
Podsumowanie
Konstruktory publiczne |
|---|
Builder() |
Metody publiczne |
|
|---|---|
final @NonNull GetGoogleIdOption.Builder |
associateLinkedAccounts(Określa, czy obsługiwać logowanie za pomocą kont Google połączonych z kontami użytkowników. |
final @NonNull GetGoogleIdOption |
build() |
final @NonNull GetGoogleIdOption.Builder |
setAutoSelectEnabled(boolean autoSelectEnabled)Ustawia w żądaniu działanie automatycznego wyboru. |
final @NonNull GetGoogleIdOption.Builder |
Określa roszczenia, które mają być uwzględnione w tokenie identyfikatora Google. |
final @NonNull GetGoogleIdOption.Builder |
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)Określa, czy użytkownik może wybierać tylko konta Google, które mają już uprawnienia do logowania się w Twojej aplikacji. |
final @NonNull GetGoogleIdOption.Builder |
setHostedDomainFilter(String hostedDomainFilter)Ustawia filtr hostowanej domeny, aby ograniczyć logowanie przez Google do kont w określonej domenie Google Workspace. |
final @NonNull GetGoogleIdOption.Builder |
Ustawia wartość nonce, która ma być używana podczas generowania tokena identyfikatora Google. |
final @NonNull GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)Określa, czy podczas rejestracji ma być wymagany zweryfikowany numer telefonu. |
final @NonNull GetGoogleIdOption.Builder |
setServerClientId(@NonNull String serverClientId)Ustawia identyfikator klienta serwera, który będzie używany jako odbiorca tokenów identyfikatora Google generowanych podczas logowania. |
Konstruktory publiczne
Metody publiczne
associateLinkedAccounts
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
Określa, czy obsługiwać logowanie za pomocą kont Google połączonych z kontami użytkowników.
Gdy wybierzesz takie dane logowania, najpierw na Twój serwer zostanie przesłany token identyfikatora Google dla konta Google, z którym połączone jest wybrane konto, a następnie zostanie on zwrócony do Ciebie. Podobnie jak w przypadku zwykłego logowania backend może użyć tokena identyfikatora do zalogowania użytkownika. Pamiętaj, że token identyfikatora zostanie przekazany tylko podczas pierwszego logowania przy użyciu tych danych logowania. Kolejne logowania nie będą wymagać weryfikacji, ponieważ token identyfikatora będzie już powiązany z kontem użytkownika.
| Parametry | |
|---|---|
@NonNull String linkedServiceId |
identyfikator usługi używany podczas łączenia kont z kontem Google. |
List<@NonNull String> idTokenDepositionScopes |
Zakresy OAuth, których Google będzie potrzebować, aby przesłać token identyfikatora Google na serwer backendu aplikacji. To pole jest opcjonalne i może mieć wartość null. Wymagane tylko wtedy, gdy Google wymaga określonych zakresów, aby można było zdeponować token tożsamości. |
setAutoSelectEnabled
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
Ustawia w żądaniu działanie automatycznego wyboru.
W przypadku użytkowników, którzy wyrażą na to zgodę, funkcja automatycznego wyboru umożliwia automatyczne wybranie danych logowania bez czekania na działanie użytkownika (np. kliknięcie przycisku „Dalej”). Dane logowania mogą być wybierane automatycznie, jeśli: 1) do logowania można użyć tylko jednych danych logowania; 2) nie trzeba podejmować żadnych dalszych działań związanych z tymi danymi logowania (np. uprawnienia do udostępniania danych zostały już zebrane w przypadku konta Google).
setClaims
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
Określa roszczenia, które mają być uwzględnione w tokenie identyfikatora Google.
Listę dostępnych roszczeń znajdziesz w dokumentacji. Nieobsługiwane roszczenia będą ignorowane.
setFilterByAuthorizedAccounts
public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)
Określa, czy użytkownik może wybierać tylko konta Google, które mają już uprawnienia do logowania się w Twojej aplikacji. Wartość domyślna to true (prawda).
Jeśli wartość to {@code true}, użytkownik nie będzie mógł wybrać żadnego konta Google, które w innych okolicznościach wymagałoby wyraźnej autoryzacji do udostępniania aplikacji podstawowych danych profilu lub adresu e-mail. Może to zmniejszyć pewne trudności na ścieżce logowania użytkownika i gwarantuje, że zwrócone dane logowania dotyczą „powracającego użytkownika”, ale ogranicza swobodę wyboru użytkownika spośród wszystkich kont Google na urządzeniu.
| Parametry | |
|---|---|
boolean filterByAuthorizedAccounts |
czy zezwalać użytkownikowi tylko na wybieranie kont Google, które mają już uprawnienia do logowania się w aplikacji; |
setHostedDomainFilter
public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)
Ustawia filtr hostowanej domeny, aby ograniczyć logowanie przez Google do kont w określonej domenie Google Workspace.
Przekazanie wartości null lub pustego ciągu znaków spowoduje brak filtrowania.
| Parametry | |
|---|---|
String hostedDomainFilter |
domena, według której chcesz filtrować (np. „example.com”) |
setNonce
public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)
Ustawia wartość nonce, która ma być używana podczas generowania tokena identyfikatora Google.
| Parametry | |
|---|---|
String nonce |
wartość nonce do użycia podczas generowania tokena identyfikatora, |
setRequestVerifiedPhoneNumber
public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)
Określa, czy podczas rejestracji ma być wymagany zweryfikowany numer telefonu.
Aby korzystać z tej funkcji, pole [filterByAuthorizedAccounts] musi mieć wartość false, ponieważ jest ona dostępna tylko podczas rejestracji.
setServerClientId
public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)
Ustawia identyfikator klienta serwera, który będzie używany jako odbiorca tokenów identyfikatora Google generowanych podczas logowania.