GetGoogleIdOption

Kotlin |Java

public final class GetGoogleIdOption extends GetCustomCredentialOption

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

---

用于检索用户 Google ID 令牌的请求。

抛出
java.lang.IllegalArgumentException	如果 serverClientId 为空
java.lang.IllegalArgumentException	如果 filterByAuthorizedAccounts 和 requestVerifiedPhoneNumber 均为 true。
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	如果在从软件包创建 GetGoogleIdOption 时遇到任何错误。

摘要

嵌套类型
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) 用于根据给定 Bundle 创建 GetGoogleIdOption 的辅助函数。
final boolean	getAutoSelectEnabled() 设置请求中的自动选择行为。注册。
final List<@NonNull Claim>	getClaims()
final boolean	getFilterByAuthorizedAccounts() 是否仅允许用户从已获授权登录您应用的 Google 账号中进行选择，默认值为 true
final String	getHostedDomainFilter() 要过滤的网域（例如“example.com”）
final List<@NonNull String>	getIdTokenDepositionScopes() Google 需要哪些 OAuth 范围才能将 Google ID 令牌存入您应用的后端服务器。
final String	getLinkedServiceId() 将账号与 Google 账号相关联时使用的服务 ID
final String	getNonce() 在生成 ID 令牌期间使用的随机数
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 int getTypePriorityHint() final boolean isAutoSelectAllowed() final boolean isSystemProviderRequired()

公共构造函数

GetGoogleIdOption

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
)

公共方法

createFrom

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

用于根据给定 Bundle 创建 GetGoogleIdOption 的辅助函数。

参数
@NonNull Bundle data	包含有关 GetGoogleIdOption 的所有必要信息的软件包。

getAutoSelectEnabled

public final boolean getAutoSelectEnabled()

设置请求中的自动选择行为。注册。

getClaims

public final List<@NonNull Claim> getClaims()

getFilterByAuthorizedAccounts

public final boolean getFilterByAuthorizedAccounts()

是否仅允许用户从已获授权登录您应用的 Google 账号中进行选择，默认值为 true

getHostedDomainFilter

public final String getHostedDomainFilter()

要过滤的网域（例如“example.com”）

getIdTokenDepositionScopes

public final List<@NonNull String> getIdTokenDepositionScopes()

Google 需要哪些 OAuth 范围才能将 Google ID 令牌存入您应用的后端服务器。此参数为可选参数，可以设置为 null。仅当 Google 要求提供特定范围才能存入 ID 令牌时，才需要提供此参数。

getLinkedServiceId

public final String getLinkedServiceId()

将账号与 Google 账号相关联时使用的服务 ID

getNonce

public final String getNonce()

在生成 ID 令牌期间使用的随机数

getRequestVerifiedPhoneNumber

public final boolean getRequestVerifiedPhoneNumber()

是否在注册期间请求验证电话号码。

getServerClientId

public final @NonNull String getServerClientId()

将向其签发 ID 令牌的服务器的客户端 ID