GetGoogleIdOption.Builder
class GetGoogleIdOption.Builder
Ein Builder für GetGoogleIdOption.
Zusammenfassung
Öffentliche Konstruktoren |
|---|
Builder() |
Öffentliche Funktionen |
|
|---|---|
GetGoogleIdOption.Builder |
associateLinkedAccounts(Legt fest, ob die Anmeldung mit Google-Konten unterstützt werden soll, die mit den Konten Ihrer Nutzer verknüpft sind. |
GetGoogleIdOption |
build() |
GetGoogleIdOption.Builder |
setAutoSelectEnabled(autoSelectEnabled: Boolean)Legt das Verhalten für die automatische Auswahl in der Anfrage fest. |
GetGoogleIdOption.Builder |
Legt die Ansprüche fest, die im Google-ID-Token enthalten sein sollen. |
GetGoogleIdOption.Builder |
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)Legt fest, ob der Nutzer nur Google-Konten auswählen darf, die bereits für die Anmeldung in Ihrer Anwendung autorisiert sind. |
GetGoogleIdOption.Builder |
setHostedDomainFilter(hostedDomainFilter: String?)Legt den Filter für gehostete Domains fest, um die Google-Anmeldung auf Konten in einer bestimmten Google Workspace-Domain zu beschränken. |
GetGoogleIdOption.Builder |
Legt die Nonce fest, die beim Generieren eines Google-ID-Tokens verwendet werden soll. |
GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)Legt fest, ob bei der Registrierung eine bestätigte Telefonnummer angefordert werden soll. |
GetGoogleIdOption.Builder |
setServerClientId(serverClientId: String)Legt die Client-ID des Servers fest, die als Zielgruppe für Google-ID-Tokens verwendet werden soll, die während der Anmeldung generiert werden. |
Öffentliche Konstruktoren
Öffentliche Funktionen
associateLinkedAccounts
fun associateLinkedAccounts(
linkedServiceId: String,
idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder
Legt fest, ob die Anmeldung mit Google-Konten unterstützt werden soll, die mit den Konten Ihrer Nutzer verknüpft sind.
Wenn ein solches Anmeldedatenpaar ausgewählt wird, wird zuerst ein Google-ID-Token für das Google-Konto, mit dem das ausgewählte Konto verknüpft ist, auf Ihrem Server gespeichert und dann an Sie zurückgegeben. Ähnlich wie bei der regulären Anmeldung kann Ihr Backend das ID-Token verwenden, um den Nutzer anzumelden. Das ID-Token wird nur bei der ersten Anmeldung mit diesen Anmeldedaten hinterlegt. Bei nachfolgenden Anmeldungen ist keine Ablagerung erforderlich, da das ID-Token bereits mit dem Konto des Nutzers verknüpft wurde.
| Parameter | |
|---|---|
linkedServiceId: String |
Die Dienst-ID, die beim Verknüpfen von Konten mit einem Google-Konto verwendet wird. |
idTokenDepositionScopes: List<String>? |
OAuth-Bereiche, die Google benötigt, um ein Google-ID-Token auf dem Backend-Server Ihrer Anwendung zu hinterlegen. Dies ist optional und kann auf „null“ gesetzt werden. Nur erforderlich, wenn Google bestimmte Bereiche benötigt, um das ID-Token zu hinterlegen. |
setAutoSelectEnabled
fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder
Legt das Verhalten für die automatische Auswahl in der Anfrage fest.
Wenn Nutzer die automatische Auswahl aktivieren, kann eine Anmeldedaten automatisch ausgewählt werden, ohne dass auf eine Nutzeraktion gewartet werden muss, z. B. auf das Tippen auf die Schaltfläche „Weiter“. Anmeldedaten können automatisch ausgewählt werden, wenn 1) nur eine Anmeldedatenart für die Anmeldung verwendet werden kann und 2) keine weiteren Aktionen für diese Anmeldedaten erforderlich sind (z. B. wenn die Berechtigungen für die Datenfreigabe für ein Google-Konto bereits eingeholt wurden).
setClaims
fun setClaims(claims: List<Claim>): GetGoogleIdOption.Builder
Legt die Ansprüche fest, die im Google-ID-Token enthalten sein sollen.
Eine Liste der verfügbaren Behauptungen finden Sie in der Dokumentation. Nicht unterstützte Ansprüche werden ignoriert.
setFilterByAuthorizedAccounts
fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder
Legt fest, ob der Nutzer nur Google-Konten auswählen darf, die bereits für die Anmeldung in Ihrer Anwendung autorisiert sind. Der Standardwert ist true.
Wenn {@code true}, kann der Nutzer kein Google-Konto auswählen, für das ansonsten eine explizite Autorisierung erforderlich wäre, um grundlegende Profil-/E-Mail-Daten mit Ihrer Anwendung zu teilen. Dies kann die Anmeldung vereinfachen und garantiert, dass die zurückgegebenen Anmeldedaten für einen „wiederkehrenden Nutzer“ sind. Allerdings wird die Auswahl der Google-Konten auf dem Gerät eingeschränkt.
| Parameter | |
|---|---|
filterByAuthorizedAccounts: Boolean |
ob der Nutzer nur Google-Konten auswählen darf, die bereits für die Anmeldung bei Ihrer Anwendung autorisiert sind |
setHostedDomainFilter
fun setHostedDomainFilter(hostedDomainFilter: String?): GetGoogleIdOption.Builder
Legt den Filter für gehostete Domains fest, um die Google-Anmeldung auf Konten in einer bestimmten Google Workspace-Domain zu beschränken.
Wenn Sie einen Null- oder leeren String übergeben, erfolgt keine Filterung.
| Parameter | |
|---|---|
hostedDomainFilter: String? |
die Domain, nach der gefiltert werden soll (z.B. beispiel.de) |
setNonce
fun setNonce(nonce: String?): GetGoogleIdOption.Builder
Legt die Nonce fest, die beim Generieren eines Google-ID-Tokens verwendet werden soll.
| Parameter | |
|---|---|
nonce: String? |
Die Nonce, die bei der Generierung des ID-Tokens verwendet werden soll |
setRequestVerifiedPhoneNumber
fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder
Legt fest, ob bei der Registrierung eine bestätigte Telefonnummer angefordert werden soll.
Damit Sie diese Funktion nutzen können, muss das Feld [filterByAuthorizedAccounts] explizit auf „false“ gesetzt werden, da diese Funktion nur bei der Registrierung verfügbar ist.
setServerClientId
fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder
Legt die Client-ID des Servers fest, die als Zielgruppe für Google-ID-Tokens verwendet werden soll, die während der Anmeldung generiert werden.
| Parameter | |
|---|---|
serverClientId: String |
die Client-ID des Servers, für den das ID-Token ausgestellt wird |