API جاوا اسکریپت پشتیبانی Iframe متوسط

این صفحه مرجع API جاوا اسکریپت پشتیبانی از فریم میانی را توصیف می کند، که به شما امکان می دهد iframe میانی را در UX بعدی دستکاری کنید.

برای یادگیری نحوه استفاده از iframe های میانی، به راهنمای ادغام یک ضربه با استفاده از راهنمای Iframe مراجعه کنید.

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

روش ها
verifyParentOrigin تأیید منشأ والد را انجام می دهد
notifyParentClose به فریم والد اطلاع می دهد که جریان One Tap UX رد شده است
notifyParentDone به فریم والد اطلاع می دهد که جریان UX One Tap انجام شده است
notifyParentResize به قاب والد اطلاع می دهد که اندازه iframe میانی را تغییر دهد
notifyParentTapOutsideMode هنگامی که کاربر خارج از فریم میانی کلیک می کند، به فریم والد اطلاع می دهد که آیا فریم میانی را لغو کند یا خیر.

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

قطعه کد زیر را در هر صفحه 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"

تایید تماس مجدد

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

verificationFailed Callback

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

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

روش google.accounts.id.intermediate.notifyParentClose به قاب والد اطلاع می دهد که iframe میانی را هنگامی که جریان UX با یک ضربه رد می شود، ببندد. نمونه کد زیر را ببینید: 

google.accounts.id.intermediate.notifyParentClose()

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

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

google.accounts.id.intermediate.notifyParentDone()

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

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

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

ارتفاع

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

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

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

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

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

لغو

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