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: 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 將需要這些 OAuth 範圍，才能將 Google ID 權杖存入應用程式的後端伺服器。
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 所有必要資訊的 Bunble。

公用建構函式

GetGoogleIdOption

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

公開屬性

autoSelectEnabled

val autoSelectEnabled: Boolean

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

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

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

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

Google 需要將 Google ID 權杖存入應用程式後端伺服器的 Oauth 範圍。此為選用項目，可設為空值。只有在 Google 要求特定權限才能存放 ID 權杖時，才需要使用這個屬性。

linkedServiceId

val linkedServiceId: String?

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

Nonce

val nonce: String?

產生 ID 權杖時要使用的 Nonce

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

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

serverClientId

val serverClientId: String

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