گزینه GetGoogleId

کاتلین | جاوا

public final class GetGoogleIdOption extends 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 با خطایی مواجه شدید.

خلاصه

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

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

روش‌های عمومی
static final @ NonNull GetGoogleIdOption	createFrom (@ NonNull Bundle data) تابع کمکی برای ایجاد GetGoogleIdOption از Bundle داده شده.
final boolean	getAutoSelectEnabled () رفتار انتخاب خودکار را در درخواست تنظیم می‌کند. sign-ups.
final List <@ NonNull Claim >	getClaims ()
final boolean	getFilterByAuthorizedAccounts () آیا فقط به کاربر اجازه داده شود از بین حساب‌های گوگلی که از قبل مجاز به ورود به برنامه شما هستند، انتخاب کند؟ مقدار پیش‌فرض true است.
final String	getHostedDomainFilter () دامنه‌ای که باید بر اساس آن فیلتر شود (مثلاً "example.com")
final List <@ NonNull String >	getIdTokenDepositionScopes () Oauth مشخص می‌کند که گوگل باید یک توکن Google ID را به سرور backend برنامه شما واریز کند.
final String	getLinkedServiceId () شناسه سرویس مورد استفاده هنگام پیوند حساب‌ها به یک حساب گوگل
final String	getNonce () نانسی که باید در طول تولید توکن شناسه استفاده شود
final boolean	getRequestVerifiedPhoneNumber () آیا در هنگام ثبت نام درخواست شماره تلفن تأیید شده شود یا خیر.
final @ NonNull String	getServerClientId () شناسه کلاینت سروری که توکن شناسه به آن صادر خواهد شد

روش‌های ارثی
از androidx.credentials.CredentialOption final @ NonNull Set <@ NonNull ComponentName > getAllowedProviders () final @ NonNull Bundle getCandidateQueryData () final @ NonNull Bundle getRequestData () final @ NonNull String getType () final int getTypePriorityHint () final boolean isAutoSelectAllowed () final boolean isSystemProviderRequired ()

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

گزینه GetGoogleId

public GetGoogleIdOption(
    @NonNull String serverClientId,
    String nonce,
    boolean filterByAuthorizedAccounts,
    String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes,
    boolean requestVerifiedPhoneNumber,
    boolean autoSelectEnabled,
    List<@NonNull Claim> claims,
    String hostedDomainFilter
)

روش‌های عمومی

ایجاداز

public static final @NonNull GetGoogleIdOption createFrom(@NonNull Bundle data)

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

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

فعال‌سازی خودکار انتخاب

public final boolean getAutoSelectEnabled()

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

دریافت ادعاها

public final List<@NonNull Claim> getClaims()

getFilterByAuthorizedAccounts

public final boolean getFilterByAuthorizedAccounts()

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

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

public final String getHostedDomainFilter()

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

getIdTokenDepositionScope ها

public final List<@NonNull String> getIdTokenDepositionScopes()

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

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

public final String getLinkedServiceId()

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

دریافت نانس

public final String getNonce()

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

getRequestVerifiedPhoneNumber

public final boolean getRequestVerifiedPhoneNumber()

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

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

public final @NonNull String getServerClientId()

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