GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
یک سازنده برای GetGoogleIdOption .
خلاصه
سازندگان عمومی |
|---|
Builder () |
روشهای عمومی | |
|---|---|
final @ NonNull GetGoogleIdOption.Builder | associateLinkedAccounts (تنظیم میکند که آیا از ورود به سیستم با استفاده از حسابهای گوگل مرتبط با حسابهای کاربران شما پشتیبانی شود یا خیر. |
final @ NonNull GetGoogleIdOption | build () |
final @ NonNull GetGoogleIdOption.Builder | setAutoSelectEnabled (boolean autoSelectEnabled)رفتار انتخاب خودکار را در درخواست تنظیم میکند. |
final @ NonNull GetGoogleIdOption.Builder | ادعاهایی را که باید در توکن شناسه گوگل گنجانده شوند، تنظیم میکند. |
final @ NonNull GetGoogleIdOption.Builder | setFilterByAuthorizedAccounts (boolean filterByAuthorizedAccounts)تنظیم میکند که آیا فقط به کاربر اجازه داده شود از بین حسابهای گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند یا خیر. |
final @ NonNull GetGoogleIdOption.Builder | setHostedDomainFilter ( String hostedDomainFilter)فیلتر دامنه میزبان را برای محدود کردن ورود به سیستم با گوگل به حسابهای درون یک دامنه خاص Google Workspace تنظیم میکند. |
final @ NonNull GetGoogleIdOption.Builder | هنگام تولید توکن شناسه گوگل، nonce مورد استفاده را تنظیم میکند. |
final @ NonNull GetGoogleIdOption.Builder | setRequestVerifiedPhoneNumber (boolean requestVerifiedPhoneNumber)تنظیم میکند که آیا هنگام ثبتنام، شماره تلفن تأیید شده درخواست شود یا خیر. |
final @ NonNull GetGoogleIdOption.Builder | setServerClientId (@ NonNull String serverClientId)شناسه کلاینت سرور را برای استفاده به عنوان مخاطب برای توکنهای شناسه گوگل تولید شده در طول ورود به سیستم تنظیم میکند. |
سازندگان عمومی
روشهای عمومی
حسابهای کاربری مرتبط
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
تنظیم میکند که آیا از ورود به سیستم با استفاده از حسابهای گوگل مرتبط با حسابهای کاربران شما پشتیبانی شود یا خیر.
وقتی چنین اعتبارنامهای انتخاب میشود، یک توکن شناسه گوگل برای حساب گوگلی که حساب انتخابشده به آن متصل است، ابتدا به سرور شما واریز شده و سپس به شما بازگردانده میشود. مشابه ورود به سیستم معمولی، پشتیبان شما میتواند از توکن شناسه برای ورود کاربر استفاده کند. توجه داشته باشید که واریز توکن شناسه فقط در اولین ورود به سیستم با استفاده از این اعتبارنامه اتفاق میافتد. ورودهای بعدی نیازی به واریز نخواهند داشت، زیرا توکن شناسه از قبل با حساب کاربری شما مرتبط شده است.
| پارامترها | |
|---|---|
@ NonNull String linkedServiceId | شناسه سرویس مورد استفاده هنگام پیوند حسابها به یک حساب گوگل. |
List <@ NonNull String > idTokenDepositionScopes | دامنههای Oauth نشان میدهند که گوگل برای واریز توکن شناسه گوگل به سرور backend برنامه شما به آن نیاز خواهد داشت. این مورد اختیاری است و میتوان آن را روی null تنظیم کرد. فقط در صورتی لازم است که گوگل برای واریز توکن شناسه به دامنههای خاصی نیاز داشته باشد. |
انتخاب خودکار فعال شد
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
رفتار انتخاب خودکار را در درخواست تنظیم میکند.
برای کاربرانی که ثبتنام میکنند، «انتخاب خودکار» امکان انتخاب خودکار یک اعتبارنامه را بدون انتظار برای اقدام کاربر (مانند ضربه زدن روی دکمه «ادامه») فراهم میکند. یک اعتبارنامه میتواند به صورت خودکار انتخاب شود اگر ۱) فقط یک اعتبارنامه برای ورود به سیستم قابل استفاده باشد؛ و ۲) هیچ اقدام دیگری برای این اعتبارنامه لازم نباشد (برای مثال، مجوزهای اشتراکگذاری دادهها از قبل برای یک حساب Google جمعآوری شده باشد).
مجموعه ادعاها
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
ادعاهایی را که باید در توکن شناسه گوگل گنجانده شوند، تنظیم میکند.
برای فهرستی از ادعاهای موجود، به مستندات مراجعه کنید. هرگونه ادعای بدون پشتوانه نادیده گرفته خواهد شد.
تنظیم فیلتر توسط حسابهای مجاز
public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)
تنظیم میکند که آیا فقط به کاربر اجازه داده شود از بین حسابهای گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند یا خیر. مقدار پیشفرض true است.
اگر {@code true} باشد، کاربر قادر به انتخاب هیچ حساب گوگلی نخواهد بود که در غیر این صورت برای اشتراکگذاری دادههای اولیه پروفایل/ایمیل با برنامه شما نیاز به مجوز صریح داشته باشد. این ممکن است برخی از مشکلات در مسیر ورود کاربر را کاهش دهد و تضمین کند که اعتبارنامه برگردانده شده برای یک "کاربر در حال بازگشت" است، اما آزادی کاربر را برای انتخاب بین تمام حسابهای گوگل موجود در دستگاه محدود میکند.
| پارامترها | |
|---|---|
boolean filterByAuthorizedAccounts | آیا فقط به کاربر اجازه داده شود از بین حسابهای گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند؟ |
فیلتر دامنه میزبان تنظیم شده
public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)
فیلتر دامنه میزبان را برای محدود کردن ورود به سیستم با گوگل به حسابهای درون یک دامنه خاص Google Workspace تنظیم میکند.
ارسال یک رشته تهی یا خالی منجر به عدم فیلتر شدن میشود.
| پارامترها | |
|---|---|
String hostedDomainFilter | دامنهای که باید بر اساس آن فیلتر شود (مثلاً "example.com") |
تنظیم نانس
public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)
هنگام تولید توکن شناسه گوگل، nonce مورد استفاده را تنظیم میکند.
| پارامترها | |
|---|---|
String nonce | نانسی که باید در طول تولید توکن شناسه استفاده شود |
setRequestVerifiedPhoneNumber
public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)
تنظیم میکند که آیا هنگام ثبتنام، شماره تلفن تأیید شده درخواست شود یا خیر.
برای استفاده از این ویژگی، فیلد [filterByAuthorizedAccounts] باید صریحاً روی false تنظیم شود، زیرا این ویژگی فقط در هنگام ثبت نام در دسترس است.
تنظیم شناسه کلاینت سرور
public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)
شناسه کلاینت سرور را برای استفاده به عنوان مخاطب برای توکنهای شناسه گوگل تولید شده در طول ورود به سیستم تنظیم میکند.