GetGoogleIdOption

public final class GetGoogleIdOption extends GetCustomCredentialOption


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

抛出
java.lang.IllegalArgumentException java.lang.IllegalArgumentException

如果 serverClientId 为空

java.lang.IllegalArgumentException java.lang.IllegalArgumentException

如果 filterByAuthorizedAccountsrequestVerifiedPhoneNumber 均为 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

用于根据给定软件包创建 GetGoogleIdOption 的辅助函数。

final boolean

在请求中设置自动选择行为。

final boolean

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

final List<@NonNull String>

Google 需要将 Google ID 令牌存储到应用的后端服务器的 OAuth 范围。

final String

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

final String

在生成 ID 令牌期间要使用的 Nonce

final boolean

是否在注册期间要求提供经过验证的电话号码。

final @NonNull String

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

公共构造函数

GetGoogleIdOption

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

公共方法

createFrom

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 StringgetIdTokenDepositionScopes()

Google 需要将 Google ID 令牌存储到应用的后端服务器的 OAuth 范围。此字段为可选字段,可设置为 null。只有在 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