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

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

راجِع دليل دمج One Tap باستخدام إطار iframe للتعرّف على كيفية استخدام إطارات iframe الوسيطة.

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

الطُرق
verifyParentOrigin تُجري عملية التحقّق من مصدر الوالدَين
notifyParentClose إشعار الإطار الرئيسي بأنّه تم تخطّي مسار تجربة المستخدم في One Tap
notifyParentDone يُعلم الإطار الرئيسي بأنّ عملية One Tap UX قد اكتملت
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 الوسيط عند تخطّي تدفق تجربة المستخدم في One Tap. اطّلِع على مثال الرمز التالي للطريقة:

google.accounts.id.intermediate.notifyParentClose()

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

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

google.accounts.id.intermediate.notifyParentDone()

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

تُعلم الطريقة google.accounts.id.intermediate.notifyParentResize الإطار الرئيسي بتغيير حجم الإطار الوسيط. انظر مثال الرمز البرمجي التالي للطريقة:

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 الوسيط.