گزینه GetGoogleId

کاتلین | جاوا

class GetGoogleIdOption : GetCustomCredentialOption

کاتلین.هری
↳	گزینه اعتبارنامه‌ها در اندروید
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.گزینه GetGoogleId

---

درخواستی برای بازیابی توکن شناسه گوگل کاربر.

پرتاب‌ها
java.lang.IllegalArgumentException	اگر serverClientId خالی باشد
java.lang.IllegalArgumentException	اگر هر دو filterByAuthorizedAccounts و requestVerifiedPhoneNumber درست باشند.
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	اگر در ایجاد GetGoogleIdOption از bundle با خطایی مواجه شدید.

خلاصه

انواع تو در تو
class GetGoogleIdOption.Builder یک سازنده برای GetGoogleIdOption .

کارکردهای همراه عمومی
GetGoogleIdOption	createFrom (data: Bundle ) تابع کمکی برای ایجاد GetGoogleIdOption از Bundle داده شده.

سازندگان عمومی
GetGoogleIdOption ( serverClientId: String , nonce: String ?, filterByAuthorizedAccounts: Boolean , linkedServiceId: String ?, idTokenDepositionScopes: List < String >?, requestVerifiedPhoneNumber: Boolean , autoSelectEnabled: Boolean , claims: List < Claim >?, hostedDomainFilter: String ? )

املاک عمومی
Boolean	autoSelectEnabled رفتار انتخاب خودکار را در درخواست تنظیم می‌کند. sign-ups.
List < Claim >?	claims
Boolean	filterByAuthorizedAccounts آیا فقط به کاربر اجازه داده شود از بین حساب‌های گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند؟ مقدار پیش‌فرض true است.
String ?	hostedDomainFilter دامنه‌ای که باید بر اساس آن فیلتر شود (مثلاً "example.com")
List < String >?	idTokenDepositionScopes Oauth مشخص می‌کند که گوگل باید یک توکن Google ID را به سرور backend برنامه شما واریز کند.
String ?	linkedServiceId شناسه سرویس مورد استفاده هنگام پیوند حساب‌ها به یک حساب گوگل
String ?	nonce نانسی که باید در طول تولید توکن شناسه استفاده شود
Boolean	requestVerifiedPhoneNumber آیا در هنگام ثبت نام درخواست شماره تلفن تأیید شده شود یا خیر.
String	serverClientId شناسه کلاینت سروری که توکن شناسه به آن صادر خواهد شد

ویژگی‌های ارثی
از androidx.credentials.CredentialOption Set < ComponentName > allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type Int typePriorityHint

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

ایجاداز

fun createFrom(data: Bundle): GetGoogleIdOption

تابع کمکی برای ایجاد GetGoogleIdOption از Bundle داده شده.

پارامترها
data: Bundle	Bunble که شامل تمام اطلاعات لازم در مورد GetGoogleIdOption است.

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

گزینه GetGoogleId

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
)

املاک عمومی

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

val autoSelectEnabled: Boolean

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

ادعاها

val claims: List<Claim>?

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

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

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

val hostedDomainFilter: String?

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

دامنه‌های idTokenDeposition

val idTokenDepositionScopes: List<String>?

دامنه‌های Oauth نشان می‌دهند که گوگل برای واریز توکن شناسه گوگل به سرور backend برنامه شما به آن نیاز خواهد داشت. این مورد اختیاری است و می‌توان آن را روی null تنظیم کرد. فقط در صورتی لازم است که گوگل برای واریز توکن شناسه به دامنه‌های خاصی نیاز داشته باشد.

شناسه سرویس مرتبط

val linkedServiceId: String?

شناسه سرویس مورد استفاده هنگام پیوند حساب‌ها به یک حساب گوگل

نانس

val nonce: String?

نانسی که باید در طول تولید توکن شناسه استفاده شود

درخواستشماره تلفن تایید شده

val requestVerifiedPhoneNumber: Boolean

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

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

val serverClientId: String

شناسه کلاینت سروری که توکن شناسه به آن صادر خواهد شد