取得 GoogleIdOption.Builder

public final class GetGoogleIdOption.Builder


GetGoogleIdOption 的建構工具。

摘要

公用建構函式

公用方法

final @NonNull GetGoogleIdOption.Builder
associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

設定是否允許已登入使用者帳戶的 Google 帳戶登入。

final @NonNull GetGoogleIdOption
final @NonNull GetGoogleIdOption.Builder
setAutoSelectEnabled(boolean autoSelectEnabled)

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

final @NonNull GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

設定是否允許使用者從獲準登入應用程式的 Google 帳戶選取。

final @NonNull GetGoogleIdOption.Builder

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

final @NonNull GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

設定是否在註冊時要求已驗證的電話號碼。

final @NonNull GetGoogleIdOption.Builder
setServerClientId(@NonNull String serverClientId)

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

公用建構函式

Builder

public Builder()

公用方法

已連結帳戶

public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
    @NonNull String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes
)

設定是否允許已登入使用者帳戶的 Google 帳戶登入。

選取這類憑證時,所選帳戶所連結的 Google 帳戶 Google ID 權杖會先存入伺服器,然後傳回給您。與一般登入類似,後端可能會使用 ID 權杖登入使用者。請注意,第一次使用這個憑證權杖時,系統才會使用這個 ID 權杖存入帳戶。這樣一來,後續的登入程序就無須簽收,因為 ID 權杖已經與您的使用者帳戶建立關聯。

參數
@NonNull String linkedServiceId

服務帳戶連結至 Google 帳戶後可使用的服務 ID

List<@NonNull String> idTokenDepositionScopes

Google 需要將 Google ID 權杖存入應用程式的後端伺服器所需的 OAuth 範圍。此為選用項目,可設為空值。只有在 Google 要求特定範圍時,才能移轉 ID 權杖。

build

public final @NonNull GetGoogleIdOption build()

setAutoSelectEnabled

public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)

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

啟用這項計畫後,使用者無需等待使用者 (例如輕觸「繼續」) 按鈕,就會自動選取憑證。只有在 1) 中就有一組憑證可以用來登入,而 2) 也無需針對這個憑證採取進一步行動 (例如已經收集到 Google 帳戶的資料共用權限)。

setByByAccountsAccounts

public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)

設定是否允許使用者從獲準登入應用程式的 Google 帳戶選取。預設值為是。

如果 {@code true},使用者將無法選取任何需要明確授權的 Google 帳戶,以便將基本設定檔/電子郵件資料分享給您的應用程式。這樣可減少登入使用者歷程中的阻礙,並保證傳回的憑證適用於「回訪者」,但可限制使用者能夠在裝置上變更所有 Google 帳戶的權限。

參數
boolean filterByAuthorizedAccounts

是否僅允許使用者選取有權登入應用程式的 Google 帳戶

setNonce

public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)

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

參數
String nonce

產生 ID 權杖時要使用的 Nonce

setRequestVerifiedPhoneNumber

public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)

設定是否在註冊時要求已驗證的電話號碼。

如要使用這項功能,您必須將 [filterByAuthorizedAccounts] 欄位明確設為 false,因為這項功能只有在註冊期間才能使用。

設定伺服器用戶端 ID

public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)

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

參數
@NonNull String serverClientId

要核發 ID 權杖的伺服器用戶端 ID