مرجع واجهة برمجة تطبيقات JavaScript الخاصة بإتاحة إطار iframe الوسيط

تصف هذه الصفحة المرجعية واجهة برمجة التطبيقات Intermediate iframe Support JavaScript API، التي تستخدمها ميزة "بنقرة واحدة" لمعالجة إطار iframe الوسيط في تجربة المستخدم اللاحقة.

يُرجى الاطّلاع على دليل دمج ميزة "نقرة واحدة" باستخدام إطار iframe للتعرّف على كيفية استخدام إطارات iframe الوسيطة.

يسرد الجدول التالي جميع الطرق المتاحة وسلوكياتها.

الطُرق
verifyParentOrigin يتحقّق من المصدر الرئيسي
notifyParentClose يُرسل إشعارًا إلى الإطار الرئيسي بأنّه تم تخطّي مسار تجربة المستخدم في ميزة "نقرة واحدة"
notifyParentDone يُرسل إشعارًا إلى الإطار الرئيسي بأنّ مسار تجربة المستخدم لميزة "نقرة واحدة" قد اكتمل
notifyParentResize يُرسل إشعارًا إلى الإطار الرئيسي لتغيير حجم إطار iframe الوسيط
notifyParentTapOutsideMode يُعلم الإطار الرئيسي بما إذا كان يجب إلغاء إطار iframe الوسيط عندما ينقر المستخدم خارج إطار iframe الوسيط

تحميل مكتبة JavaScript الخاصة بدعم إطارات 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 طريقة ردّ الاتصال في JavaScript التي يتم تشغيلها عندما يُسمح للمصدر الرئيسي الحالي بتضمين إطار iframe الوسيط.
verificationFailedCallback طريقة ردّ الاتصال في JavaScript التي يتم تشغيلها عندما لا يُسمح للمصدر الرئيسي الحالي بتضمين إطار 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

هذا الحقل هو طريقة رد اتصال JavaScript يتم تشغيلها عندما يُسمح للمصدر الرئيسي الحالي بتضمين إطار iframe الوسيط.

verificationFailedCallback

هذا الحقل هو طريقة رد اتصال JavaScript يتم تشغيلها عندما لا يُسمح للمصدر الرئيسي الحالي بتضمين إطار iframe الوسيط.

الطريقة: google.accounts.id.intermediate.notifyParentClose

تُرسِل طريقة google.accounts.id.intermediate.notifyParentClose إشعارًا إلى الإطار الرئيسي لإغلاق إطار iframe الوسيط عند تخطّي مسار تجربة المستخدم في ميزة &quot;نقرة واحدة&quot;. اطّلِع على مثال الرمز البرمجي التالي للطريقة:

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)

الارتفاع

الارتفاع الجديد بالبكسل هذا الحقل إلزامي. يجب أن تكون القيمة رقمًا غير سالب.

إذا كانت مَعلمة الارتفاع أكبر من 0، يتم ضبط إطار iframe الوسيط على الارتفاع الجديد. إذا كانت مَعلمة الارتفاع تساوي 0، يصبح إطار iframe الوسيط غير مرئي. لم يتم إغلاق إطار iframe مخفي. ويمكن عرضه لاحقًا من خلال طلب إجراء آخر لتغيير الحجم.

الطريقة: google.accounts.id.intermediate.notifyParentTapOutsideMode

تُعلم طريقة google.accounts.id.intermediate.notifyParentTapOutsideMode الإطار الرئيسي بما إذا كان يجب إلغاء إطار iframe الوسيط عندما ينقر المستخدم خارجه. اطّلِع على مثال الرمز البرمجي التالي للطريقة:

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

إلغاء

تشير هذه القيمة المنطقية المطلوبة إلى ما إذا كان سيتم إلغاء إطار iframe الوسيط عندما ينقر المستخدم خارج إطار iframe الوسيط.