GetGoogleIdOption.Builder

Kotlin |Java

class GetGoogleIdOption.Builder

Builder untuk GetGoogleIdOption.

Ringkasan

Konstruktor publik
`Builder()`

Fungsi publik
`GetGoogleIdOption.Builder`	`associateLinkedAccounts( linkedServiceId: String, idTokenDepositionScopes: List<String>? )` Menetapkan apakah akan mendukung login menggunakan Akun Google yang ditautkan ke akun pengguna Anda.
`GetGoogleIdOption`	`build()`
`GetGoogleIdOption.Builder`	`setAutoSelectEnabled(autoSelectEnabled: Boolean)` Menetapkan perilaku pemilihan otomatis dalam permintaan.
`GetGoogleIdOption.Builder`	`setClaims(claims: List<Claim>)` Menetapkan klaim yang akan disertakan dalam token ID Google.
`GetGoogleIdOption.Builder`	`setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)` Menetapkan apakah hanya mengizinkan pengguna memilih dari Akun Google yang sudah diberi otorisasi untuk login ke aplikasi Anda.
`GetGoogleIdOption.Builder`	`setHostedDomainFilter(hostedDomainFilter: String?)` Menetapkan filter domain yang dihosting untuk membatasi Login dengan Google hanya untuk akun dalam domain Google Workspace tertentu.
`GetGoogleIdOption.Builder`	`setNonce(nonce: String?)` Menetapkan nonce yang akan digunakan saat membuat token ID Google.
`GetGoogleIdOption.Builder`	`setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)` Menetapkan apakah akan meminta nomor telepon terverifikasi selama pendaftaran.
`GetGoogleIdOption.Builder`	`setServerClientId(serverClientId: String)` Menetapkan ID klien server untuk digunakan sebagai audiens bagi token ID Google yang dibuat selama proses login.

Konstruktor publik

Builder

Builder()

Fungsi publik

associateLinkedAccounts

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

Menetapkan apakah akan mendukung login menggunakan Akun Google yang ditautkan ke akun pengguna Anda.

Jika kredensial tersebut dipilih, token ID Google untuk Akun Google yang ditautkan ke akun yang dipilih akan terlebih dahulu dikirim ke server Anda, lalu dikembalikan kepada Anda. Mirip dengan login biasa, backend Anda dapat menggunakan token ID untuk login pengguna. Perhatikan bahwa deposisi token ID hanya akan terjadi saat pertama kali login, menggunakan kredensial ini. Login berikutnya tidak akan memerlukan deposisi, karena token ID akan telah dikaitkan dengan akun pengguna Anda.

Parameter
`linkedServiceId: String`	ID layanan yang digunakan saat menautkan akun ke Akun Google.
`idTokenDepositionScopes: List<String>?`	Cakupan OAuth yang akan diperlukan Google untuk menyetor token ID Google ke server backend aplikasi Anda. Parameter ini bersifat opsional dan dapat disetel ke null. Hanya diperlukan jika Google mewajibkan cakupan tertentu agar dapat menyetor token ID.

build

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

Menetapkan perilaku pemilihan otomatis dalam permintaan.

Untuk pengguna yang memilih ikut serta, Pemilihan Otomatis memungkinkan kredensial dipilih secara otomatis tanpa menunggu tindakan pengguna (seperti mengetuk tombol "lanjutkan"). Kredensial dapat dipilih otomatis jika 1) hanya satu kredensial yang dapat digunakan untuk login; dan 2) tidak ada tindakan lebih lanjut yang perlu dilakukan untuk kredensial ini (misalnya, izin berbagi data sudah dikumpulkan untuk Akun Google).

setClaims

fun setClaims(claims: List<Claim>): GetGoogleIdOption.Builder

Menetapkan klaim yang akan disertakan dalam token ID Google.

Untuk mengetahui daftar klaim yang tersedia, lihat dokumentasi. Klaim yang tidak didukung akan diabaikan.

Parameter
`claims: List<Claim>`	daftar klaim.

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

Menetapkan apakah hanya mengizinkan pengguna memilih dari Akun Google yang sudah diberi otorisasi untuk login ke aplikasi Anda. Nilai defaultnya adalah benar (true).

Jika {@code true}, pengguna tidak akan dapat memilih Akun Google yang jika tidak, akan memerlukan otorisasi eksplisit untuk membagikan data profil/email dasar ke aplikasi Anda. Hal ini dapat mengurangi beberapa hambatan dalam perjalanan pengguna saat login, dan menjamin bahwa kredensial yang ditampilkan adalah untuk "pengguna yang kembali", tetapi membatasi kebebasan pengguna untuk memilih di antara semua Akun Google di perangkat.

Parameter
`filterByAuthorizedAccounts: Boolean`	apakah hanya mengizinkan pengguna memilih dari Akun Google yang sudah diberi otorisasi untuk login ke aplikasi Anda

setHostedDomainFilter

fun setHostedDomainFilter(hostedDomainFilter: String?): GetGoogleIdOption.Builder

Menetapkan filter domain yang dihosting untuk membatasi Login dengan Google hanya untuk akun dalam domain Google Workspace tertentu.

Jika string null atau kosong diteruskan, pemfilteran tidak akan dilakukan.

Parameter
`hostedDomainFilter: String?`	domain yang akan difilter (misalnya, "example.com")

setNonce

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

Menetapkan nonce yang akan digunakan saat membuat token ID Google.

Parameter
`nonce: String?`	nonce yang akan digunakan selama pembuatan token ID

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

Menetapkan apakah akan meminta nomor telepon terverifikasi selama pendaftaran.

Untuk menggunakan fitur ini, kolom [filterByAuthorizedAccounts] harus ditetapkan secara eksplisit ke false, karena fitur ini hanya tersedia selama pendaftaran.

setServerClientId

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

Menetapkan ID klien server untuk digunakan sebagai audiens bagi token ID Google yang dibuat selama proses login.

Parameter
`serverClientId: String`	ID klien server yang akan menerbitkan token ID