GetGoogleIdOption.Builder

Kotlin |Java

class GetGoogleIdOption.Builder

---

Kreator dla GetGoogleIdOption.

Podsumowanie

Konstruktory publiczne
Builder()

Funkcje publiczne
GetGoogleIdOption.Builder	associateLinkedAccounts(     linkedServiceId: String,     idTokenDepositionScopes: List<String>? ) Określa, czy obsługiwać logowanie za pomocą kont Google połączonych z kontami użytkowników.
GetGoogleIdOption	build()
GetGoogleIdOption.Builder	setAutoSelectEnabled(autoSelectEnabled: Boolean) Ustawia w żądaniu działanie automatycznego wyboru.
GetGoogleIdOption.Builder	setClaims(claims: List<Claim>) Określa roszczenia, które mają być uwzględnione w tokenie identyfikatora Google.
GetGoogleIdOption.Builder	setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean) Określa, czy użytkownik może wybierać tylko konta Google, które mają już uprawnienia do logowania się w Twojej aplikacji.
GetGoogleIdOption.Builder	setHostedDomainFilter(hostedDomainFilter: String?) Ustawia filtr hostowanej domeny, aby ograniczyć logowanie przez Google do kont w określonej domenie Google Workspace.
GetGoogleIdOption.Builder	setNonce(nonce: String?) Ustawia wartość nonce, która ma być używana podczas generowania tokena identyfikatora Google.
GetGoogleIdOption.Builder	setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean) Określa, czy podczas rejestracji ma być wymagany zweryfikowany numer telefonu.
GetGoogleIdOption.Builder	setServerClientId(serverClientId: String) Ustawia identyfikator klienta serwera, który będzie używany jako odbiorca tokenów identyfikatora Google generowanych podczas logowania.

Konstruktory publiczne

Monter

Builder()

Funkcje publiczne

associateLinkedAccounts

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

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
linkedServiceId: String	identyfikator usługi używany podczas łączenia kont z kontem Google.
idTokenDepositionScopes: List<String>?	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.

kompilacja

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

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ą zostać wybrane automatycznie, jeśli: 1) do logowania można użyć tylko jednych danych logowania; 2) nie trzeba podejmować żadnych dalszych działań w przypadku tych danych logowania (np. uprawnienia do udostępniania danych zostały już zebrane w przypadku konta Google).

setClaims

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

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.

Parametry
claims: List<Claim>	listę roszczeń.

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

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
filterByAuthorizedAccounts: Boolean	czy zezwalać użytkownikowi tylko na wybieranie kont Google, które mają już uprawnienia do logowania się w aplikacji;

setHostedDomainFilter

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

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
hostedDomainFilter: String?	domena, według której chcesz filtrować (np. „example.com”)

setNonce

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

Ustawia wartość nonce, która ma być używana podczas generowania tokena identyfikatora Google.

Parametry
nonce: String?	wartość nonce do użycia podczas generowania tokena identyfikatora,

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

Ustawia identyfikator klienta serwera, który będzie używany jako odbiorca tokenów identyfikatora Google generowanych podczas logowania.

Parametry
serverClientId: String	identyfikator klienta serwera, do którego zostanie wydany token identyfikatora;