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 權杖存入應用程式的後端伺服器。這項設定為選用項目，可以設為空值。只有在 Google 要求特定範圍才能存入 ID 權杖時，才需要提供這項資訊。

linkedServiceId

val linkedServiceId: String?

將帳戶連結至 Google 帳戶時使用的服務 ID

Nonce

val nonce: String?

在產生 ID 權杖時使用的隨機值

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

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

serverClientId

val serverClientId: String

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