GetGoogleIdOption.Builder

class GetGoogleIdOption.Builder


‫Builder ל-GetGoogleIdOption.

סיכום

‫constructors ציבוריים

פונקציות ציבוריות

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

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

GetGoogleIdOption
GetGoogleIdOption.Builder
setAutoSelectEnabled(autoSelectEnabled: Boolean)

הגדרת התנהגות הבחירה האוטומטית בבקשה.

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

הפונקציה מגדירה את ההצהרות שייכללו באסימון מזהה Google.

GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)

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

GetGoogleIdOption.Builder
setHostedDomainFilter(hostedDomainFilter: String?)

הגדרת המסנן של הדומיין המתארח כדי להגביל את הכניסה לחשבון Google לחשבונות בדומיין ספציפי ב-Google Workspace.

GetGoogleIdOption.Builder
setNonce(nonce: String?)

מגדיר את הערך החד-פעמי לשימוש כשיוצרים אסימון מזהה של Google.

GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)

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

GetGoogleIdOption.Builder
setServerClientId(serverClientId: String)

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

‫constructors ציבוריים

בנאי

Builder()

פונקציות ציבוריות

associateLinkedAccounts

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

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

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

פרמטרים
linkedServiceId: String

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

idTokenDepositionScopes: List<String>?

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

לבנות גרסת build

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

הגדרת התנהגות הבחירה האוטומטית בבקשה.

משתמשים שמסכימים לכך יכולים להשתמש באפשרות 'בחירה אוטומטית' כדי לבחור אישורים באופן אוטומטי בלי לחכות לפעולת משתמש (כמו הקשה על הלחצן 'המשך'). יכול להיות שפרטי כניסה ייבחרו באופן אוטומטי אם 1) אפשר להשתמש רק בפרטי כניסה אחדים לכניסה; ו-2) לא צריך לבצע פעולות נוספות לגבי פרטי הכניסה האלה (לדוגמה, הרשאות שיתוף הנתונים כבר נאספו לגבי חשבון Google).

setClaims

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

הפונקציה מגדירה את ההצהרות שייכללו באסימון מזהה Google.

רשימת הטענות הזמינות מופיעה במסמכי התיעוד. המערכת תתעלם מתלונות שלא נתמכות.

פרמטרים
claims: List<Claim>

רשימה של תלונות.

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

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

אם הערך הוא {@code true}, המשתמש לא יוכל לבחור חשבון Google שנדרשת עבורו הרשאה מפורשת לשיתוף נתונים בסיסיים של פרופיל או אימייל עם האפליקציה שלכם. השינוי הזה עשוי להפחית את החיכוך בתהליך הכניסה של המשתמשים, ומבטיח שהאישורים שיוחזרו יהיו של 'משתמשים חוזרים', אבל הוא מגביל את חופש הבחירה של המשתמשים בין כל חשבונות Google במכשיר.

פרמטרים
filterByAuthorizedAccounts: Boolean

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

setHostedDomainFilter

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

הגדרת המסנן של הדומיין המתארח כדי להגביל את הכניסה לחשבון Google לחשבונות בדומיין ספציפי ב-Google Workspace.

אם מעבירים מחרוזת ריקה או null, לא מתבצע סינון.

פרמטרים
hostedDomainFilter: String?

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

setNonce

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

מגדיר את הערך החד-פעמי לשימוש כשיוצרים אסימון מזהה של Google.

פרמטרים
nonce: String?

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

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

כדי להשתמש בתכונה הזו, צריך להגדיר במפורש את השדה [filterByAuthorizedAccounts] כ-false, כי התכונה זמינה רק במהלך ההרשמה.

setServerClientId

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

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

פרמטרים
serverClientId: String

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