GetGoogleIdOption.Builder

کاتلین | جاوا

class GetGoogleIdOption.Builder

---

یک سازنده برای GetGoogleIdOption .

خلاصه

سازندگان عمومی
Builder ()

کارکردهای عمومی
GetGoogleIdOption.Builder	associateLinkedAccounts ( linkedServiceId: String , idTokenDepositionScopes: List < String >? ) تنظیم می‌کند که آیا از ورود به سیستم با استفاده از حساب‌های گوگل مرتبط با حساب‌های کاربران شما پشتیبانی شود یا خیر.
GetGoogleIdOption	build ()
GetGoogleIdOption.Builder	setAutoSelectEnabled (autoSelectEnabled: Boolean ) رفتار انتخاب خودکار را در درخواست تنظیم می‌کند.
GetGoogleIdOption.Builder	setClaims (claims: List < Claim >) ادعاهایی را که باید در توکن شناسه گوگل گنجانده شوند، تنظیم می‌کند.
GetGoogleIdOption.Builder	setFilterByAuthorizedAccounts (filterByAuthorizedAccounts: Boolean ) تنظیم می‌کند که آیا فقط به کاربر اجازه داده شود از بین حساب‌های گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند یا خیر.
GetGoogleIdOption.Builder	setHostedDomainFilter (hostedDomainFilter: String ?) فیلتر دامنه میزبان را برای محدود کردن ورود به سیستم با گوگل به حساب‌های درون یک دامنه خاص Google Workspace تنظیم می‌کند.
GetGoogleIdOption.Builder	setNonce (nonce: String ?) هنگام تولید توکن شناسه گوگل، nonce مورد استفاده را تنظیم می‌کند.
GetGoogleIdOption.Builder	setRequestVerifiedPhoneNumber (requestVerifiedPhoneNumber: Boolean ) تنظیم می‌کند که آیا هنگام ثبت‌نام، شماره تلفن تأیید شده درخواست شود یا خیر.
GetGoogleIdOption.Builder	setServerClientId (serverClientId: String ) شناسه کلاینت سرور را برای استفاده به عنوان مخاطب برای توکن‌های شناسه گوگل تولید شده در طول ورود به سیستم تنظیم می‌کند.

سازندگان عمومی

سازنده

Builder()

کارکردهای عمومی

حساب‌های کاربری مرتبط

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

تنظیم می‌کند که آیا از ورود به سیستم با استفاده از حساب‌های گوگل مرتبط با حساب‌های کاربران شما پشتیبانی شود یا خیر.

وقتی چنین اعتبارنامه‌ای انتخاب می‌شود، یک توکن شناسه گوگل برای حساب گوگلی که حساب انتخاب‌شده به آن متصل است، ابتدا به سرور شما واریز شده و سپس به شما بازگردانده می‌شود. مشابه ورود به سیستم معمولی، پشتیبان شما می‌تواند از توکن شناسه برای ورود کاربر استفاده کند. توجه داشته باشید که واریز توکن شناسه فقط در اولین ورود به سیستم با استفاده از این اعتبارنامه اتفاق می‌افتد. ورودهای بعدی نیازی به واریز نخواهند داشت، زیرا توکن شناسه از قبل با حساب کاربری شما مرتبط شده است.

پارامترها
linkedServiceId: String	شناسه سرویس مورد استفاده هنگام پیوند حساب‌ها به یک حساب گوگل.
idTokenDepositionScopes: List < String >?	دامنه‌های Oauth نشان می‌دهند که گوگل برای واریز توکن شناسه گوگل به سرور backend برنامه شما به آن نیاز خواهد داشت. این اختیاری است و می‌توان آن را روی null تنظیم کرد. فقط در صورتی لازم است که گوگل برای واریز توکن شناسه به دامنه‌های خاصی نیاز داشته باشد.

ساختن

fun build(): GetGoogleIdOption

انتخاب خودکار فعال شد

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

رفتار انتخاب خودکار را در درخواست تنظیم می‌کند.

برای کاربرانی که ثبت‌نام می‌کنند، «انتخاب خودکار» امکان انتخاب خودکار یک اعتبارنامه را بدون انتظار برای اقدام کاربر (مانند ضربه زدن روی دکمه «ادامه») فراهم می‌کند. یک اعتبارنامه می‌تواند به صورت خودکار انتخاب شود اگر ۱) فقط یک اعتبارنامه برای ورود به سیستم قابل استفاده باشد؛ و ۲) هیچ اقدام دیگری برای این اعتبارنامه لازم نباشد (برای مثال، مجوزهای اشتراک‌گذاری داده‌ها از قبل برای یک حساب Google جمع‌آوری شده باشد).

مجموعه ادعاها

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

ادعاهایی را که باید در توکن شناسه گوگل گنجانده شوند، تنظیم می‌کند.

برای فهرستی از ادعاهای موجود، به مستندات مراجعه کنید. هرگونه ادعای بدون پشتوانه نادیده گرفته خواهد شد.

پارامترها
claims: List < Claim >	فهرستی از ادعاها

تنظیم فیلتر توسط حساب‌های مجاز

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

تنظیم می‌کند که آیا فقط به کاربر اجازه داده شود از بین حساب‌های گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند یا خیر. مقدار پیش‌فرض true است.

اگر {@code true} باشد، کاربر قادر به انتخاب هیچ حساب گوگلی نخواهد بود که در غیر این صورت برای اشتراک‌گذاری داده‌های اولیه پروفایل/ایمیل با برنامه شما نیاز به مجوز صریح داشته باشد. این ممکن است برخی از مشکلات در مسیر ورود کاربر را کاهش دهد و تضمین کند که اعتبارنامه برگردانده شده برای یک "کاربر در حال بازگشت" است، اما آزادی کاربر را برای انتخاب بین تمام حساب‌های گوگل موجود در دستگاه محدود می‌کند.

پارامترها
filterByAuthorizedAccounts: Boolean	آیا فقط به کاربر اجازه داده شود از بین حساب‌های گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند؟

فیلتر دامنه میزبان تنظیم شده

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

فیلتر دامنه میزبان را برای محدود کردن ورود به سیستم با گوگل به حساب‌های درون یک دامنه خاص Google Workspace تنظیم می‌کند.

ارسال یک رشته تهی یا خالی منجر به عدم فیلتر شدن می‌شود.

پارامترها
hostedDomainFilter: String ?	دامنه‌ای که باید بر اساس آن فیلتر شود (مثلاً "example.com")

تنظیم نانس

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

هنگام تولید توکن شناسه گوگل، nonce مورد استفاده را تنظیم می‌کند.

پارامترها
nonce: String ?	نانسی که باید در طول تولید توکن شناسه استفاده شود

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

تنظیم می‌کند که آیا هنگام ثبت‌نام، شماره تلفن تأیید شده درخواست شود یا خیر.

برای استفاده از این ویژگی، فیلد [filterByAuthorizedAccounts] باید صریحاً روی false تنظیم شود، زیرا این ویژگی فقط در هنگام ثبت نام در دسترس است.

تنظیم شناسه کلاینت سرور

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

شناسه کلاینت سرور را برای استفاده به عنوان مخاطب برای توکن‌های شناسه گوگل تولید شده در طول ورود به سیستم تنظیم می‌کند.

پارامترها
serverClientId: String	شناسه کلاینت سروری که توکن شناسه به آن صادر خواهد شد