GetGoogleIdOption.Builder

class GetGoogleIdOption.Builder


GetGoogleIdOption 的构建器。

总结

公共构造函数

公共函数

GetGoogleIdOption.Builder
associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
)

设置是否支持使用与用户帐号关联的 Google 帐号登录。

GetGoogleIdOption
GetGoogleIdOption.Builder
setAutoSelectEnabled(autoSelectEnabled: Boolean)

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

GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)

设置是否允许用户仅从已获得授权来登录您应用的 Google 帐号中进行选择。

GetGoogleIdOption.Builder
setNonce(nonce: String?)

设置要在生成 Google ID 令牌时使用的 Nonce。

GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)

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

GetGoogleIdOption.Builder
setServerClientId(serverClientId: String)

设置服务器的客户端 ID,用作登录期间生成的 Google ID 令牌的受众群体。

公共构造函数

构建器

Builder()

公共函数

关联的帐号

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

设置是否支持使用与用户帐号关联的 Google 帐号登录。

选择此类凭据后,系统会先将所选帐号关联的 Google 帐号的 Google ID 令牌存入您的服务器,然后再将其返回给您。与常规登录类似,您的后端可以使用 ID 令牌让用户登录。请注意,ID 令牌存储仅在第一次使用此凭据登录时进行。此后登录无需存入,因为此 ID 令牌已与您的用户帐号相关联。

参数
linkedServiceId: String

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

idTokenDepositionScopes: List<String>?

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

build

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

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

对于选择启用该功能的用户,自动选择功能可自动选择凭据,而无需等待用户操作(例如点按“继续”按钮)。在以下情况下,可以自动选择凭据:1) 只能使用一个凭据登录;2) 无需对该凭据执行任何其他操作(例如,Google 帐号已收集数据共享权限)。

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

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

如果 {@code true},则用户无法选择任何需要明确授权才能与您的应用共享基本个人资料/电子邮件数据的 Google 帐号。这可能会减少登录用户体验历程中的一些阻碍,并保证返回的凭据是针对“回访用户”的,但会限制用户可以自由选择设备上的所有 Google 帐号。

参数
filterByAuthorizedAccounts: Boolean

仅允许用户从已获准登录您应用的 Google 帐号中进行选择

setNonce

fun setNonce(nonce: String?): GetGoogleIdOption.Builder

设置要在生成 Google ID 令牌时使用的 Nonce。

参数
nonce: String?

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

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

如需使用此功能,必须明确将 [filterByAuthorizedAccounts] 字段设置为 false,因为此功能仅在注册期间可用。

setServerClientId

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

设置服务器的客户端 ID,用作登录期间生成的 Google ID 令牌的受众群体。

参数
serverClientId: String

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