GetGoogleIdOption

Kotlin |Java

class GetGoogleIdOption : GetCustomCredentialOption

kotlin.Any
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.GetGoogleIdOption

---

בקשה לאחזור טוקן מזהה של משתמש ב-Google.

מקפיצה את הודעות השגיאה (Throws)
java.lang.IllegalArgumentException	אם serverClientId ריק
java.lang.IllegalArgumentException	אם גם filterByAuthorizedAccounts וגם requestVerifiedPhoneNumber נכונים.
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	אם נתקלתם בשגיאה כלשהי במהלך יצירת GetGoogleIdOption מחבילה.

סיכום

סוגי רכיבים שמוצבים בתוך רכיבים אחרים
class GetGoogleIdOption.Builder ‫Builder ל-GetGoogleIdOption.

פונקציות ציבוריות של Companion
GetGoogleIdOption	createFrom(data: Bundle) פונקציית עזר ליצירת GetGoogleIdOption מתוך Bundle נתון.

‫constructors ציבוריים
GetGoogleIdOption(     serverClientId: String,     nonce: String?,     filterByAuthorizedAccounts: Boolean,     linkedServiceId: String?,     idTokenDepositionScopes: List<String>?,     requestVerifiedPhoneNumber: Boolean,     autoSelectEnabled: Boolean,     claims: List<Claim>?,     hostedDomainFilter: String? )

מאפיינים ציבוריים
Boolean	autoSelectEnabled מגדיר את אופן הבחירה האוטומטית בבקשות להרשמה.
List<Claim>?	claims
Boolean	filterByAuthorizedAccounts האם לאפשר למשתמש לבחור רק מתוך חשבונות Google שכבר קיבלו הרשאה להיכנס לאפליקציה שלכם. ערך ברירת המחדל הוא true.
String?	hostedDomainFilter הדומיין שלפיו רוצים לסנן (למשל, ‪"example.com")
List<String>?	idTokenDepositionScopes היקפי OAuth ש-Google תצטרך להפקיד טוקן מזהה של Google בשרת הבק-אנד של האפליקציה.
String?	linkedServiceId מזהה השירות שמשמש לקישור חשבונות לחשבון Google
String?	nonce ה-nonce לשימוש במהלך יצירת אסימון המזהה
Boolean	requestVerifiedPhoneNumber אם לבקש מספר טלפון מאומת במהלך ההרשמה.
String	serverClientId מזהה הלקוח של השרת שיונפק לו טוקן הזהות

מאפיינים שעוברים בירושה
‫From androidx.credentials.CredentialOption Set<ComponentName> allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type Int typePriorityHint

פונקציות ציבוריות של Companion

createFrom

fun createFrom(data: Bundle): GetGoogleIdOption

פונקציית עזר ליצירת GetGoogleIdOption מתוך Bundle נתון.

פרמטרים
data: Bundle	חבילה שמכילה את כל המידע הנחוץ על GetGoogleIdOption.

‫constructors ציבוריים

GetGoogleIdOption

GetGoogleIdOption(
    serverClientId: String,
    nonce: String? = null,
    filterByAuthorizedAccounts: Boolean = true,
    linkedServiceId: String? = null,
    idTokenDepositionScopes: List<String>? = null,
    requestVerifiedPhoneNumber: Boolean = false,
    autoSelectEnabled: Boolean = false,
    claims: List<Claim>? = null,
    hostedDomainFilter: String? = null
)

מאפיינים ציבוריים

autoSelectEnabled

val autoSelectEnabled: Boolean

מגדיר את אופן הבחירה האוטומטית בבקשות להרשמה.

תלונה

val claims: List<Claim>?

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

האם לאפשר למשתמש לבחור רק מתוך חשבונות Google שכבר קיבלו הרשאה להיכנס לאפליקציה שלכם. ערך ברירת המחדל הוא true.

hostedDomainFilter

val hostedDomainFilter: String?

הדומיין שלפיו רוצים לסנן (למשל, example.com)

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

היקפי OAuth ש-Google תצטרך להפקיד טוקן מזהה של Google בשרת הבק-אנד של האפליקציה. השדה הזה הוא אופציונלי ואפשר להגדיר בו את הערך null. נדרש רק אם Google דורשת היקפי הרשאות מסוימים כדי להפקיד את אסימון המזהה.

linkedServiceId

val linkedServiceId: String?

מזהה השירות שמשמש לקישור חשבונות לחשבון Google

צופן חד-פעמי (nonce)

val nonce: String?

ה-nonce לשימוש במהלך יצירת אסימון המזהה

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

אם לבקש מספר טלפון מאומת במהלך ההרשמה.

serverClientId

val serverClientId: String

מזהה הלקוח של השרת שיונפק לו טוקן הזהות