Referensi JavaScript API Dukungan iframe menengah

Halaman referensi ini menjelaskan Intermediate iframe Support JavaScript API, yang digunakan oleh Login Sekali Klik untuk memanipulasi iframe perantara dalam UX berikutnya.

Lihat panduan Mengintegrasikan Login Sekali Ketuk menggunakan Iframe untuk mempelajari cara menggunakan iframe perantara.

Tabel berikut mencantumkan semua metode yang tersedia dan perilakunya.

Metode
verifyParentOrigin melakukan verifikasi asal induk
notifyParentClose memberi tahu frame induk bahwa alur UX Login Sekali Ketuk dilewati
notifyParentDone memberi tahu frame induk bahwa alur UX Login Sekali Klik telah selesai
notifyParentResize memberi tahu frame induk untuk mengubah ukuran iframe perantara
notifyParentTapOutsideMode memberi tahu frame induk apakah akan membatalkan iframe perantara saat pengguna mengklik di luar iframe perantara

Memuat Library JavaScript Dukungan Iframe Menengah

Tempatkan cuplikan kode berikut ke halaman HTML mana pun tempat Anda ingin memuat iframe perantara:

<script src="https://accounts.google.com/gsi/intermediatesupport"></script>

Metode: google.accounts.id.intermediate.verifyParentOrigin

Metode google.accounts.id.intermediate.verifyParentOrigin melakukan verifikasi asal induk. Lihat contoh kode metode berikut:

google.accounts.id.intermediate.verifyParentOrigin(
    origins, verifiedCallback, verificationFailedCallback)

Contoh kode berikut menunjukkan cara menampilkan UI hanya setelah asal induk diverifikasi:

<script>
  window.onload = () => {
    google.accounts.id.intermediate.verifyParentOrigin(
        "https://example.com", showUI, showError);
  };
</script>

Tabel berikut mencantumkan parameter:

Parameter
origins Origin yang diizinkan untuk menyematkan iframe perantara.
verifiedCallback Metode callback JavaScript dipicu saat origin induk saat ini diizinkan untuk menyematkan iframe perantara.
verificationFailedCallback Metode callback JavaScript yang dipicu saat asal induk saat ini tidak diizinkan untuk menyematkan iframe perantara.

asal

Origin yang diizinkan untuk menyematkan iframe perantara. Lihat tabel berikut untuk mengetahui informasi selengkapnya:

Jenis Wajib Contoh
string, array string, atau fungsi Opsional allowed_parent_origin: "https://example.com"

Tabel berikut mencantumkan jenis nilai yang didukung dan deskripsinya.

Jenis Nilai
string URI domain tunggal. "https://example.com"
string array Array URI domain. "https://news.example.com,https://local.example.com"

verifiedCallback

Kolom ini adalah metode callback JavaScript yang dipicu saat asal induk saat ini diizinkan untuk menyematkan iframe perantara.

verificationFailedCallback

Kolom ini adalah metode callback JavaScript yang dipicu saat origin induk saat ini tidak diizinkan untuk menyematkan iframe perantara.

Metode: google.accounts.id.intermediate.notifyParentClose

Metode google.accounts.id.intermediate.notifyParentClose memberi tahu frame induk untuk menutup iframe perantara saat alur UX Login Sekali Ketuk dilewati. Lihat contoh kode metode berikut:

google.accounts.id.intermediate.notifyParentClose()

Metode: google.accounts.id.intermediate.notifyParentDone

Metode google.accounts.id.intermediate.notifyParentClose memberi tahu frame induk untuk menutup iframe perantara dan memuat ulang status login. Lihat contoh kode metode berikut:

google.accounts.id.intermediate.notifyParentDone()

Metode: google.accounts.id.intermediate.notifyParentResize

Metode google.accounts.id.intermediate.notifyParentResize memberi tahu frame induk untuk mengubah ukuran iframe perantara. Lihat contoh kode berikut dari metode:

google.accounts.id.intermediate.notifyParentResize(height)

tinggi

Tinggi baru dalam piksel. Bidang ini harus diisi. Nilai harus berupa bilangan positif.

Jika parameter tinggi lebih besar dari 0, iframe perantara akan disetel ke tinggi baru. Jika parameter tinggi adalah 0, iframe perantara menjadi tidak terlihat. Iframe tersembunyi tidak ditutup. Ini dapat ditampilkan nanti dengan panggilan metode pengubahan ukuran lainnya.

Metode: google.accounts.id.intermediate.notifyParentTapOutsideMode

Metode google.accounts.id.intermediate.notifyParentTapOutsideMode memberi tahu frame induk apakah akan membatalkan iframe perantara saat pengguna mengklik di luar iframe perantara. Lihat contoh kode metode berikut:

google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)

batal

Nilai boolean yang diperlukan ini menunjukkan apakah akan membatalkan iframe perantara saat pengguna mengklik di luar iframe perantara.