取得 GoogleIdOption

Kotlin |Java

public final class GetGoogleIdOption extends GetCustomCredentialOption

java.lang.Object
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.library.identity.googleid.GetGoogleIdOption

---

擷取使用者的 Google ID 權杖的要求。

擲回
java.lang.IllegalArgumentException java.lang.IllegalArgumentException	如果 serverClientId 空白
java.lang.IllegalArgumentException java.lang.IllegalArgumentException	如果 filterByAuthorizedAccounts 和 requestVerifiedPhoneNumber 皆為 true。
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	從套件建立 GetGoogleIdOption 時發生錯誤。

摘要

巢狀類型
public final class GetGoogleIdOption.Builder GetGoogleIdOption 的建構工具。
public static class GetGoogleIdOption.Companion

公用建構函式
GetGoogleIdOption(     @NonNull String serverClientId,     String nonce,     boolean filterByAuthorizedAccounts,     String linkedServiceId,     List<@NonNull String> idTokenDepositionScopes,     boolean requestVerifiedPhoneNumber,     boolean autoSelectEnabled )

公用方法
static final @NonNull GetGoogleIdOption	createFrom(@NonNull Bundle data) 用於針對特定套件建立 GetGoogleIdOption 的輔助函式。
final boolean	getAutoSelectEnabled() 設定要求中的自動選取行為。註冊。
final boolean	getFilterByAuthorizedAccounts() 是否只允許使用者選取有權登入應用程式的 Google 帳戶，預設值為 True
final List<@NonNull String>	getIdTokenDepositionScopes() Google 需要將 Google ID 權杖存入應用程式的後端伺服器所需的 OAuth 範圍。
final String	getLinkedServiceId() 將帳戶連結至 Google 帳戶時使用的服務 ID
final String	getNonce() 產生 ID 權杖時要使用的 Nonce
final boolean	getRequestVerifiedPhoneNumber() 在註冊過程中是否要求驗證已驗證的電話號碼。
final @NonNull String	getServerClientId() 要核發 ID 權杖的伺服器用戶端 ID

繼承方法
來自 androidx.credentials.CredentialOption final @NonNull Set<@NonNull ComponentName> getAllowedProviders() final @NonNull Bundle getCandidateQueryData() final @NonNull Bundle getRequestData() final @NonNull String getType() final boolean isAutoSelectAllowed() final boolean isSystemProviderRequired()

公用建構函式

取得 GoogleIdOption

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

公用方法

建立來源

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

用於針對特定套件建立 GetGoogleIdOption 的輔助函式。

參數
@NonNull Bundle data	包含 GetGoogleIdOption 的所有必要資訊。

getAutoSelectEnabled

public final boolean getAutoSelectEnabled()

設定要求中的自動選取行為。註冊。

getFilterByAuthorizedAccounts

public final boolean getFilterByAuthorizedAccounts()

是否只允許使用者選取有權登入應用程式的 Google 帳戶，預設值為 True

getIdTokenDepositionScopes

public final List<@NonNull String> getIdTokenDepositionScopes()

Google 需要將 Google ID 權杖存入應用程式的後端伺服器所需的 OAuth 範圍。此為選用項目，可設為空值。只有在 Google 要求特定範圍時，才能移轉 ID 權杖。

getLinkedServiceId

public final String getLinkedServiceId()

將帳戶連結至 Google 帳戶時使用的服務 ID

getNonce

public final String getNonce()

產生 ID 權杖時要使用的 Nonce

getRequestVerifiedPhoneNumber

public final boolean getRequestVerifiedPhoneNumber()

在註冊過程中是否要求驗證已驗證的電話號碼。

getServerClientId

public final @NonNull String getServerClientId()

要核發 ID 權杖的伺服器用戶端 ID