GetGoogleIdOption.Builder

Kotlin |Java

class GetGoogleIdOption.Builder

GetGoogleIdOption 的建構工具。

摘要

公用建構函式
`Builder()`

公開函式
`GetGoogleIdOption.Builder`	`associateLinkedAccounts( linkedServiceId: String, idTokenDepositionScopes: List<String>? )` 設定是否允許使用與使用者連結的 Google 帳戶登入帳戶。
`GetGoogleIdOption`	`build()`
`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 帳戶登入。

選取這類憑證後，選取的帳戶已連結，會先存入您的伺服器，再傳回您。與一般登入程序類似，後端可以使用 ID 權杖登入使用者。請注意，ID 權杖存證只會在使用此憑證首次登入時發生。之後使用者每次登入時就不需要存款，因為 ID 權杖會已與該使用者的帳戶連結。

參數
`linkedServiceId: String`	連結帳戶至 Google 帳戶時使用的服務 ID。
`idTokenDepositionScopes: List<String>?`	Google 需要將 Google ID 權杖存入應用程式的後端伺服器，所需的 OAuth 範圍。這是選用值，可設為空值。只有在 Google 要求特定權限才能存放 ID 權杖時，才需要使用這個屬性。

fun build(): GetGoogleIdOption

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

設定要求中的自動選取行為。

對於選擇啟用這項功能的使用者，系統會自動選取憑證，無須等待使用者採取任何動作 (例如輕觸「繼續」按鈕)。如果符合以下條件，系統就會自動選取憑證：1) 登入時只能使用一個憑證；2) 不需要針對這個憑證採取進一步行動 (例如，已為 Google 帳戶收集資料分享權限)。

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

設定是否只允許使用者選取已授權登入應用程式的 Google 帳戶。預設值為 true。

如果為 {@code true}，使用者就無法選取任何 Google 帳戶，否則這些帳戶需要明確授權，才能與您的應用程式共用基本個人資料/電子郵件資料。這麼做或許能減少登入使用者歷程中的摩擦，並確保傳回的憑證是「回訪使用者」專用，但會限制使用者無法自由選擇裝置上的所有 Google 帳戶。

參數
`filterByAuthorizedAccounts: Boolean`	是否只允許使用者選取已授權登入應用程式的 Google 帳戶

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

設定產生 Google ID 權杖時要使用的 Nonce。

參數
`nonce: String?`	產生 ID 權杖時要使用的 Nonce

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

設定是否要在註冊時要求使用者提供已驗證的電話號碼。

如要使用這項功能，[filterByAuthorizedAccounts] 欄位必須明確設為 false，因為這項功能僅適用於註冊期間。

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

將伺服器的用戶端 ID 設為登入期間產生的 Google ID 權杖的目標對象。

參數
`serverClientId: String`	要發出 ID 權杖的伺服器用戶端 ID