GetGoogleIdOption

Kotlin |Java

class GetGoogleIdOption : GetCustomCredentialOption

kotlin.Any
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.GetGoogleIdOption

---

คำขอเรียกข้อมูลโทเค็นรหัส Google ของผู้ใช้

ส่ง
java.lang.IllegalArgumentException	หาก serverClientId ว่างเปล่า
java.lang.IllegalArgumentException	หากทั้ง filterByAuthorizedAccounts และ requestVerifiedPhoneNumber เป็นจริง
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	หากพบข้อผิดพลาดในการสร้าง GetGoogleIdOption จาก Bundle

สรุป

ประเภทที่ซ้อนกัน
class GetGoogleIdOption.Builder ผู้รับสร้างบ้านใน GetGoogleIdOption

ฟังก์ชันแอปที่แสดงร่วมสาธารณะ
GetGoogleIdOption	createFrom(data: Bundle) ฟังก์ชันตัวช่วยในการสร้าง GetGoogleIdOption จาก Bundle ที่กำหนด

เครื่องมือสร้างสาธารณะ
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 ที่ได้รับอนุญาตให้ลงชื่อเข้าใช้แอปพลิเคชันของคุณแล้วเท่านั้นหรือไม่ ค่าเริ่มต้นคือจริง
String?	hostedDomainFilter โดเมนที่จะกรอง (เช่น "example.com")
List<String>?	idTokenDepositionScopes ขอบเขต OAuth ที่ Google จะต้องใช้เพื่อฝากโทเค็นรหัส Google ไปยังเซิร์ฟเวอร์แบ็กเอนด์ของแอปพลิเคชัน
String?	linkedServiceId รหัสบริการที่ใช้เมื่อลิงก์บัญชีกับบัญชี Google
String?	nonce ค่า Nonce ที่จะใช้ในระหว่างการสร้างโทเค็นรหัส
Boolean	requestVerifiedPhoneNumber เลือกว่าจะขอหมายเลขโทรศัพท์ที่ยืนยันแล้วในระหว่างการลงชื่อสมัครใช้หรือไม่
String	serverClientId รหัสไคลเอ็นต์ของเซิร์ฟเวอร์ที่จะออกโทเค็นรหัส

พร็อพเพอร์ตี้ที่รับช่วง
จาก androidx.credentials.CredentialOption Set<ComponentName> allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type Int typePriorityHint

ฟังก์ชันแอปที่แสดงร่วมสาธารณะ

createFrom

fun createFrom(data: Bundle): GetGoogleIdOption

ฟังก์ชันตัวช่วยในการสร้าง GetGoogleIdOption จาก Bundle ที่กำหนด

พารามิเตอร์
data: Bundle	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 ที่ได้รับอนุญาตให้ลงชื่อเข้าใช้แอปพลิเคชันของคุณแล้วเท่านั้นหรือไม่ ค่าเริ่มต้นคือจริง

hostedDomainFilter

val hostedDomainFilter: String?

โดเมนที่จะกรอง (เช่น "example.com")

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

ขอบเขต OAuth ที่ Google จะต้องใช้เพื่อฝากโทเค็นรหัส Google ไปยังเซิร์ฟเวอร์แบ็กเอนด์ของแอปพลิเคชัน โดยคุณจะระบุหรือไม่ก็ได้ และตั้งค่าเป็น null ได้ จำเป็นเฉพาะในกรณีที่ Google กำหนดให้ต้องมีขอบเขตที่เฉพาะเจาะจงจึงจะฝากโทเค็นรหัสได้

linkedServiceId

val linkedServiceId: String?

รหัสบริการที่ใช้เมื่อลิงก์บัญชีกับบัญชี Google

ค่าที่ได้จากการสุ่ม

val nonce: String?

ค่า Nonce ที่จะใช้ในระหว่างการสร้างโทเค็นรหัส

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

เลือกว่าจะขอหมายเลขโทรศัพท์ที่ยืนยันแล้วในระหว่างการลงชื่อสมัครใช้หรือไม่

serverClientId

val serverClientId: String

รหัสไคลเอ็นต์ของเซิร์ฟเวอร์ที่จะออกโทเค็นรหัส