Meneruskan Status dalam Tindakan Email

Anda dapat meneruskan status melalui continue URL saat mengirim tindakan email untuk mereset sandi atau memverifikasi email pengguna. Dengan begitu, pengguna dapat kembali ke aplikasi setelah tindakan selesai. Selain itu, Anda dapat menentukan apakah akan menangani link tindakan email langsung dari aplikasi seluler saat diinstal, bukan dari halaman web.

Hal ini bisa sangat berguna dalam skenario umum berikut:

  • Pengguna, yang tidak sedang login, mungkin mencoba mengakses konten yang mengharuskannya untuk login. Namun, pengguna mungkin lupa sandinya sehingga memicu proses reset sandi. Pada akhir proses, pengguna tersebut ingin kembali ke bagian aplikasi yang semula ingin diakses.

  • Aplikasi mungkin hanya menawarkan akses ke akun yang terverifikasi. Misalnya, suatu newsletter mungkin mengharuskan pengguna untuk memverifikasi emailnya sebelum berlangganan. Setelah melalui proses verifikasi email, pengguna tentunya ingin kembali ke aplikasi untuk menyelesaikan langganan mereka.

  • Dalam kasus lain, pengguna mungkin telah memulai proses ini dari perangkat seluler dan, setelah verifikasi, ingin kembali ke aplikasi seluler, bukan browser.

Kemampuan dalam meneruskan status melalui continue URL merupakan fitur yang sangat bermanfaat dari Firebase Auth, yang memungkinkan pengguna untuk mendapatkan pengalaman yang jauh lebih baik.

Meneruskan status continue URL dalam tindakan email

Agar bisa meneruskan continue URL dengan aman, domain untuk URL harus diberi akses di Firebase console. Hal ini dilakukan di bagian Authentication dengan menambahkan domain ini ke daftar Authorized domains di bawah tab Sign-in method, jika domain tersebut belum ada di daftar.

Instance ActionCodeSettings harus diberikan saat mengirim email reset sandi atau email verifikasi. Instance ini dapat dibuat dengan class ActionCodeSettings.Builder terkait yang berisi metode berikut:

Metode Deskripsi
setUrl(String url)

Menetapkan link (status/continue URL) yang memiliki arti berbeda dalam konteks lain:

  • Jika link ditangani di dalam widget tindakan web, ini adalah deep link dalam parameter kueri continueUrl.
  • Saat link ditangani di aplikasi secara langsung, ini adalah parameter kueri continueUrl di deep link dari link Hosting.
setIOSBundleId(String iOSBundleId) Menetapkan ID paket iOS untuk membantu Firebase Authentication dalam menentukan apakah harus membuat link khusus web atau link seluler yang terbuka di perangkat Apple
setAndroidPackageName(String androidPackageName, boolean installIfNotAvailable, String minimumVersion) Menetapkan nama paket Android untuk membantu Firebase Authentication dalam menentukan apakah harus membuat link khusus web atau link seluler yang terbuka di perangkat Android
setHandleCodeInApp(boolean status) Apakah link tindakan email akan dibuka di aplikasi seluler atau link web terlebih dahulu. Secara default, nilainya adalah false. Saat disetel ke true, link kode tindakan akan dikirim sebagai Link Universal atau Link Aplikasi Android dan akan dibuka oleh aplikasi jika sudah terinstal. Jika disetel ke false, kode akan dikirim ke widget web terlebih dahulu, kemudian akan dialihkan ke aplikasi jika sudah terinstal.
setLinkDomain(String customDomain) Jika domain link Hosting kustom ditetapkan untuk suatu project, tentukan domain yang akan digunakan saat link dibuka oleh aplikasi seluler yang ditentukan. Jika tidak, domain default akan dipilih secara otomatis (misalnya, PROJECT_ID.firebaseapp.com).
setDynamicLinkDomain(String dynamicLinkDomain) Tidak digunakan lagi. Jangan tentukan parameter ini.

Contoh berikut menggambarkan cara mengirimkan link verifikasi email yang akan dibuka di aplikasi seluler terlebih dahulu. Deep link akan berisi payload continue URL http://www.example.com/verify?uid=1234.

Kotlin

val auth = Firebase.auth
val user = auth.currentUser!!

val url = "http://www.example.com/verify?uid=" + user.uid
val actionCodeSettings = ActionCodeSettings.newBuilder()
    .setUrl(url)
    .setIOSBundleId("com.example.ios")
    // The default for this is populated with the current android package name.
    .setAndroidPackageName("com.example.android", false, null)
    .build()

user.sendEmailVerification(actionCodeSettings)
    .addOnCompleteListener { task ->
        if (task.isSuccessful) {
            Log.d(TAG, "Email sent.")
        }
    }

Java

FirebaseAuth auth = FirebaseAuth.getInstance();
FirebaseUser user = auth.getCurrentUser();

String url = "http://www.example.com/verify?uid=" + user.getUid();
ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder()
        .setUrl(url)
        .setIOSBundleId("com.example.ios")
        // The default for this is populated with the current android package name.
        .setAndroidPackageName("com.example.android", false, null)
        .build();

user.sendEmailVerification(actionCodeSettings)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                if (task.isSuccessful()) {
                    Log.d(TAG, "Email sent.");
                }
            }
        });

Firebase Authentication menggunakan Firebase Hosting saat mengirim link yang dimaksudkan untuk dibuka di aplikasi seluler. Untuk menggunakan fitur ini, link Hosting perlu dikonfigurasi di Firebase console.

  1. Mengonfigurasi aplikasi Android:

    1. Jika ingin menangani link ini dari aplikasi Android, Anda harus menentukan nama paket aplikasi di setelan project Firebase console. Selain itu, SHA-1 dan SHA-256 sertifikat aplikasi harus dimasukkan.
    2. Anda juga harus mengonfigurasi filter intent untuk deep link di file AndroidManifest.xml.
    3. Untuk mengetahui informasi selengkapnya, lihat petunjuk Menerima Hosting links Android.
  2. Mengonfigurasi aplikasi iOS:

    1. Jika ingin menangani link ini dari aplikasi iOS, Anda harus mengonfigurasi domain link Hosting sebagai Domain Terkait (Associated Domain) dalam kemampuan aplikasi Anda.
    2. Untuk mengetahui informasi selengkapnya, lihat Petunjuk Menerima Hosting links iOS.

Menangani tindakan email dalam aplikasi web

Anda dapat menentukan apakah akan menangani link kode tindakan dari aplikasi web terlebih dahulu, kemudian dialihkan ke halaman web atau aplikasi seluler lain setelah berhasil diselesaikan, jika aplikasi seluler tersedia. Hal ini dilakukan dengan memanggil setHandleCodeInApp(false) di objek ActionCodeSettings.Builder. Meskipun ID paket iOS atau nama paket Android tidak wajib, pengguna dapat dialihkan kembali ke aplikasi yang ditentukan saat penyelesaian kode tindakan email jika ID atau nama tersebut diberikan.

URL web yang digunakan di sini adalah yang dikonfigurasi di bagian template tindakan email. URL default disediakan untuk semua project. Baca artikel menyesuaikan pengendali email untuk mempelajari lebih lanjut cara menyesuaikan pengendali tindakan email.

Dalam kasus ini, link dalam parameter kueri continueUrl akan menjadi link Hosting yang payload-nya adalah URL sebagaimana ditentukan dalam objek ActionCodeSettings.

Saat menangani tindakan email, seperti verifikasi email, kode tindakan dari parameter kueri oobCode harus diurai dari deep link, lalu diterapkan melalui applyActionCode agar perubahan diterapkan, yaitu email tersebut diverifikasi.

Menangani tindakan email dalam aplikasi seluler

Anda dapat menentukan apakah akan menangani link kode tindakan dalam aplikasi seluler Anda terlebih dahulu jika aplikasi tersebut sudah terinstal. Jika diklik dari perangkat yang tidak mendukung aplikasi seluler tersebut, link akan dibuka dari halaman web. Hal ini dilakukan dengan memanggil setHandleCodeInApp(true) in the ActionCodeSettings.Builder. Nama paket Android atau ID paket iOS dari aplikasi seluler itu juga harus ditentukan.

URL web fallback yang digunakan di sini adalah yang dikonfigurasi di bagian template tindakan email jika tidak ada aplikasi seluler yang tersedia. URL default disediakan untuk semua project. Baca artikel menyesuaikan pengendali email untuk mempelajari lebih lanjut cara menyesuaikan pengendali tindakan email.

Dalam kasus ini, link aplikasi seluler yang dikirimkan kepada pengguna adalah link Hosting yang payload-nya adalah URL kode tindakan yang dikonfigurasi di Console, dengan parameter kueri oobCode, mode, apiKey, dan continueUrl. Parameter kueri yang disebut terakhir adalah URL asli yang ditentukan dalam objek ActionCodeSettings. Kode tindakan dapat diterapkan secara langsung dari aplikasi seluler, mirip dengan ketika ditangani dari alur web yang dijelaskan di bagian menyesuaikan pengendali email.

Saat menangani tindakan email, seperti verifikasi email, kode tindakan dari parameter kueri oobCode harus diurai dari deep link, lalu diterapkan melalui applyActionCode agar perubahan diterapkan, yaitu email tersebut diverifikasi.