获取 GoogleIdOption

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: 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 时遇到任何错误。

总结

嵌套类型
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 )

公共属性
Boolean	autoSelectEnabled 在请求中设置自动选择行为。
Boolean	filterByAuthorizedAccounts 仅允许用户从已获得授权来登录您应用的 Google 帐号中进行选择，默认值为 true
List<String>?	idTokenDepositionScopes Google 需要将 Google ID 令牌存入应用的后端服务器的 OAuth 范围。
String?	linkedServiceId 将帐号与 Google 帐号关联时使用的服务 ID
String?	nonce 在生成 ID 令牌期间使用的 Nonce
Boolean	requestVerifiedPhoneNumber 是否要求在注册期间提供经过验证的电话号码。
String	serverClientId 签发 ID 令牌的服务器的客户端 ID

继承的属性
通过 androidx.credentials.CredentialOption Set<ComponentName> allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type

公开配套函数

createFrom

fun createFrom(data: Bundle): GetGoogleIdOption

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

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

公共构造函数

获取 GoogleIdOption

GetGoogleIdOption(
    serverClientId: String,
    nonce: String? = null,
    filterByAuthorizedAccounts: Boolean = true,
    linkedServiceId: String? = null,
    idTokenDepositionScopes: List<String>? = null,
    requestVerifiedPhoneNumber: Boolean = false,
    autoSelectEnabled: Boolean = false
)

公共属性

自动选择

val autoSelectEnabled: Boolean

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

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

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

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

Google 需要将 Google ID 令牌存入应用的后端服务器的 OAuth 范围。可选参数，可以设置为 null。仅在 Google 要求特定范围才能存储 ID 令牌时才需要输入。

关联的服务 ID

val linkedServiceId: String?

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

nonce

val nonce: String?

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

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

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

serverClientId

val serverClientId: String

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