مرجع میانای برنامه‌سازی کاربردی جاوا اسکریپت پشتیبانی iframe واسط

این صفحه مرجع، Intermediate iframe Support JavaScript API را شرح می‌دهد، که One Tap از آن برای دستکاری iframe واسط در UX بعدی استفاده می‌کند.

برای آشنایی با نحوه استفاده از iframe واسطه، به راهنمای ادغام One Tap بااستفاده از Iframe مراجعه کنید.

جدول زیر همه روش‌های دردسترس و رفتارهای آن‌ها را فهرست می‌کند.

روش‌ها
verifyParentOrigin درستی‌سنجی مبدأ والد را انجام می‌دهد
notifyParentClose به قاب اصلی اطلاع می‌دهد که جریان UX «ورود با یک ضربه» رد شده است
notifyParentDone به قاب اصلی اطلاع می‌دهد که جریان تجربه کاربری «ورود با یک ضربه» انجام شده است
notifyParentResize به قاب ولی اطلاع می‌دهد که اندازه iframe واسطه را تغییر دهد
notifyParentTapOutsideMode به قاب اصلی اطلاع می‌دهد که آیا iframe میانی را لغو کند یا نه وقتی کاربر خارج از iframe میانی کلیک می‌کند

بار کردن کتابخانه جاوا اسکریپت پشتیبانی Iframe واسط

تکه‌کد زیر را در هر صفحه HTML که می‌خواهید iframe واسط در آن بار شود قرار دهید:

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

روش: google.accounts.id.intermediate.verifyParentOrigin

روش google.accounts.id.intermediate.verifyParentOrigin درستی‌سنجی مبدأ اصلی را انجام می‌دهد. نمونه کد زیر را برای این روش ببینید:

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

نمونه کد زیر نشان می‌دهد که چگونه واسط کاربر را فقط پس‌از تأیید مبدأ اصلی نمایش دهید:

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

جدول زیر پارامترها را فهرست می‌کند:

پارامتر
origins مبدأهایی که مجاز به جاسازی iframe واسطه هستند.
verifiedCallback روش فراخوانی جاوا اسکریپت زمانی فعال می‌شود که مبدأ والد فعلی مجاز به جاسازی iframe میانی باشد.
verificationFailedCallback روش فراخوانی جاوا اسکریپت زمانی فعال می‌شود که مبدأ والد فعلی مجاز به جاسازی iframe میانی نباشد.

مبدأها

مبدأهایی که مجاز به جاسازی iframe واسط هستند. برای اطلاعات بیشتر، جدول زیر را ببینید:

نوع الزامی مثال
رشته، آرایه رشته‌ای، یا تابع اختیاری allowed_parent_origin: "https://example.com"

جدول زیر انواع مقدار پشتیبانی‌شده و شرح آن‌ها را فهرست می‌کند.

انواع مقدار
string یک URI دامنه. "https://example.com"
string array آرایه‌ای از URIهای دامنه. "https://news.example.com,https://local.example.com"

verifiedCallback

این فیلد یک روش فراخوانی جاوا اسکریپت است که وقتی مبدأ والد فعلی مجاز به جاسازی iframe میانی باشد، فعال می‌شود.

verificationFailedCallback

این فیلد یک روش فراخوانی جاوا اسکریپت است که وقتی مبدأ والد فعلی مجاز به جاسازی iframe میانی نباشد، فعال می‌شود.

روش: google.accounts.id.intermediate.notifyParentClose

روش google.accounts.id.intermediate.notifyParentClose به قاب اصلی اطلاع می‌دهد که وقتی جریان تجربه کاربری «ورود با یک ضربه» رد شد، iframe واسطه را ببندد. نمونه کد زیر را برای این روش ببینید:

google.accounts.id.intermediate.notifyParentClose()

روش: google.accounts.id.intermediate.notifyParentDone

روش google.accounts.id.intermediate.notifyParentDone به قاب اصلی اطلاع می‌دهد که iframe واسطه را ببندد و وضعیت ورود به سیستم را بازآوری کند. نمونه کد زیر را برای این روش ببینید:

google.accounts.id.intermediate.notifyParentDone()

روش: google.accounts.id.intermediate.notifyParentResize

روش google.accounts.id.intermediate.notifyParentResize به قاب اصلی اطلاع می‌دهد که اندازه iframe واسطه را تغییر دهد. نمونه کد زیر را برای این روش ببینید:

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

ارتفاع

ارتفاع جدید به پیکسل. این فیلد الزامی است. مقدار باید عدد غیرمنفی باشد.

اگر پارامتر ارتفاع بزرگ‌تر از ۰ باشد، iframe واسطه روی ارتفاع جدید تنظیم می‌شود. اگر پارامتر ارتفاع ۰ باشد، iframe واسطه نامرئی می‌شود. iframe پنهان بسته نشده است. می‌توان آن را بعداً با فراخوانی روش تغییر اندازه دیگری نشان داد.

روش: google.accounts.id.intermediate.notifyParentTapOutsideMode

روش google.accounts.id.intermediate.notifyParentTapOutsideMode به قاب والد اطلاع می‌دهد که آیا iframe واسط را هنگام کلیک کردن کاربر در خارج از iframe واسط لغو کند یا نه. نمونه کد زیر را برای این روش ببینید:

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

لغو کردن

این مقدار بولی الزامی نشان می‌دهد که آیا iframe واسط لغو شود یا نه وقتی کاربر خارج از iframe واسط کلیک می‌کند.