GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
Builder untuk GetGoogleIdOption.
Ringkasan
Konstruktor publik |
|---|
Builder() |
Metode publik |
|
|---|---|
final @NonNull GetGoogleIdOption.Builder |
associateLinkedAccounts(Menetapkan apakah akan mendukung login menggunakan Akun Google yang ditautkan ke akun pengguna Anda. |
final @NonNull GetGoogleIdOption |
build() |
final @NonNull GetGoogleIdOption.Builder |
setAutoSelectEnabled(boolean autoSelectEnabled)Menetapkan perilaku pemilihan otomatis dalam permintaan. |
final @NonNull GetGoogleIdOption.Builder |
Menetapkan klaim yang akan disertakan dalam token ID Google. |
final @NonNull GetGoogleIdOption.Builder |
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)Menetapkan apakah hanya mengizinkan pengguna memilih dari Akun Google yang sudah diberi otorisasi untuk login ke aplikasi Anda. |
final @NonNull GetGoogleIdOption.Builder |
setHostedDomainFilter(String hostedDomainFilter)Menetapkan filter domain yang dihosting untuk membatasi Login dengan Google hanya untuk akun dalam domain Google Workspace tertentu. |
final @NonNull GetGoogleIdOption.Builder |
Menetapkan nonce yang akan digunakan saat membuat token ID Google. |
final @NonNull GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)Menetapkan apakah akan meminta nomor telepon terverifikasi selama pendaftaran. |
final @NonNull GetGoogleIdOption.Builder |
setServerClientId(@NonNull String serverClientId)Menetapkan ID klien server untuk digunakan sebagai audiens bagi token ID Google yang dibuat selama proses login. |
Konstruktor publik
Metode publik
associateLinkedAccounts
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
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 | |
|---|---|
@NonNull String linkedServiceId |
ID layanan yang digunakan saat menautkan akun ke Akun Google. |
List<@NonNull String> idTokenDepositionScopes |
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. |
setAutoSelectEnabled
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
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
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
Menetapkan klaim yang akan disertakan dalam token ID Google.
Untuk mengetahui daftar klaim yang tersedia, lihat dokumentasi. Klaim yang tidak didukung akan diabaikan.
setFilterByAuthorizedAccounts
public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)
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 | |
|---|---|
boolean filterByAuthorizedAccounts |
apakah hanya mengizinkan pengguna memilih dari Akun Google yang sudah diberi otorisasi untuk login ke aplikasi Anda |
setHostedDomainFilter
public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)
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 | |
|---|---|
String hostedDomainFilter |
domain yang akan difilter (misalnya, "example.com") |
setNonce
public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)
Menetapkan nonce yang akan digunakan saat membuat token ID Google.
| Parameter | |
|---|---|
String nonce |
nonce yang akan digunakan selama pembuatan token ID |
setRequestVerifiedPhoneNumber
public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)
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
public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)
Menetapkan ID klien server untuk digunakan sebagai audiens bagi token ID Google yang dibuat selama proses login.