GetGoogleIdOption

Kotlin |Java

class GetGoogleIdOption : GetCustomCredentialOption

kotlin.Any
↳	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 时遇到任何错误。

摘要

嵌套类型
class GetGoogleIdOption.Builder GetGoogleIdOption 的构建器。

公共伴生函数
GetGoogleIdOption	createFrom(data: Bundle) 用于根据给定 Bundle 创建 GetGoogleIdOption 的辅助函数。

公共构造函数
GetGoogleIdOption(     serverClientId: String,     nonce: String?,     filterByAuthorizedAccounts: Boolean,     linkedServiceId: String?,     idTokenDepositionScopes: List<String>?,     requestVerifiedPhoneNumber: Boolean,     autoSelectEnabled: Boolean,     claims: List<Claim>?,     hostedDomainFilter: String? )

公共属性
Boolean	autoSelectEnabled 设置请求中的自动选择行为。注册。
List<Claim>?	claims
Boolean	filterByAuthorizedAccounts 是否仅允许用户从已获授权登录您应用的 Google 账号中进行选择，默认值为 true
String?	hostedDomainFilter 要过滤的网域（例如“example.com”）
List<String>?	idTokenDepositionScopes Google 需要哪些 OAuth 范围才能将 Google ID 令牌存入您应用的后端服务器。
String?	linkedServiceId 将账号与 Google 账号相关联时使用的服务 ID
String?	nonce 在生成 ID 令牌期间使用的随机数
Boolean	requestVerifiedPhoneNumber 是否在注册期间请求验证电话号码。
String	serverClientId 将向其签发 ID 令牌的服务器的客户端 ID

继承的属性
来自 androidx.credentials.CredentialOption Set<ComponentName> allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type Int typePriorityHint

公共伴生函数

createFrom

fun createFrom(data: Bundle): GetGoogleIdOption

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

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

公共构造函数

GetGoogleIdOption

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
)

公共属性

autoSelectEnabled

val autoSelectEnabled: Boolean

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

版权声明

val claims: List<Claim>?

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

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

hostedDomainFilter

val hostedDomainFilter: String?

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

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

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

linkedServiceId

val linkedServiceId: String?

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

nonce

val nonce: String?

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

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

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

serverClientId

val serverClientId: String

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