Referensi JavaScript API Dukungan iframe menengah

Halaman referensi ini menjelaskan JavaScript API Dukungan iframe Menengah, yang digunakan oleh Sekali Ketuk untuk memanipulasi iframe menengah di UX berikutnya.

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

Tabel berikut mencantumkan semua metode yang tersedia dan perilakunya.

Metode
verifyParentOrigin	melakukan verifikasi origin induk
notifyParentClose	memberi tahu frame induk bahwa alur UX Sekali Ketuk dilewati
notifyParentDone	memberi tahu frame induk bahwa alur UX Sekali Ketuk 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 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 origin induk. Lihat contoh kode metode berikut:

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

Contoh kode berikut menunjukkan cara menampilkan UI hanya setelah origin 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 yang dipicu saat origin induk saat ini diizinkan untuk menyematkan iframe perantara.
verificationFailedCallback	Metode callback JavaScript yang dipicu saat origin induk saat ini tidak diizinkan untuk menyematkan iframe perantara.

origins

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

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"

Catatan: String dengan URI yang dipisahkan koma tidak valid. Gunakan objek Array JavaScript.

verifiedCallback

Kolom ini adalah metode callback JavaScript yang dipicu saat origin 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.

Peringatan: jika halaman konten tidak merespons permintaan verifikasi domain, proses verifikasi akan menunggu tanpa batas waktu. Dalam hal ini, baik verifiedCallback maupun verificationFailedCallback tidak dipanggil.

Metode: google.accounts.id.intermediate.notifyParentClose

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

google.accounts.id.intermediate.notifyParentClose()

Metode: google.accounts.id.intermediate.notifyParentDone

Metode google.accounts.id.intermediate.notifyParentDone 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 untuk metode ini:

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

Catatan: Anda tidak dapat mengubah lebar iframe perantara.

tinggi

Tinggi baru dalam piksel. Kolom ini wajib diisi. Nilainya harus berupa bilangan non-negatif.

Jika parameter tinggi lebih besar dari 0, iframe perantara akan ditetapkan ke tinggi baru. Jika parameter tinggi adalah 0, iframe perantara akan menjadi tidak terlihat. Iframe tersembunyi tidak ditutup. Elemen 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.