إدارة كائنات العميل

توضّح هذه الصفحة كيفية إدارة عناصر العميل التي يحتاج إليها أحد الإضافات للتواصل مع Google Meet.

أولاً، يجب أن تنشئ الإضافة جلسة:

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
    });

استبدِل CLOUD_PROJECT_NUMBER برقم مشروعك على Google Cloud.

من الجلسة، يمكن إنشاء كائنَي عميل:

• تمثّل MeetMainStageClient إضافة تعمل في المرحلة الرئيسية، ويمكن استردادها باستخدام await session.createMainStageClient().

• تمثّل MeetSidePanelClient معرّف الإضافة التي يتم تشغيلها في اللوحة الجانبية، ويمكن استرداده باستخدام await session.createSidePanelClient().

من المهم استرداد عنصر العميل الصحيح إما للمرحلة الرئيسية أو اللوحة الجانبية. إذا تم استرداد العميل غير الصحيح، ستعرض حزمة تطوير البرامج (SDK) الخاصة بإضافات Google Meet استثناءً. للتحقّق من إطار iframe (المرحلة الرئيسية أو اللوحة الجانبية) الذي يتم تشغيل الإضافة فيه، استخدِم طريقة getFrameType().

يوضّح نموذج الرمز التالي كيفية إنشاء عنصر عميل المنصة الرئيسية:

  const session = await window.meet.addon.createAddonSession({
      cloudProjectNumber: "CLOUD_PROJECT_NUMBER"
    });
  const mainStageClient = await session.createMainStageClient();

استبدِل CLOUD_PROJECT_NUMBER برقم مشروعك على Cloud.

الميزات المشترَكة

تتوفّر بعض الميزات في كل من عنصر MeetMainStageClient وعنصر MeetSidePanelClient، بينما تكون ميزات أخرى خاصة بعميل معيّن.

على سبيل المثال، تشمل بعض الميزات المتوفّرة في كلتا البيئتين ما يلي:

• الطريقة getActivityStartingState() التي تحصل على معلومات حول الحالة الأولية للإضافة عندما يقبل المشارك الدعوة للانضمام إلى النشاط.
• الطريقة getMeetingInfo() التي تحصل على تفاصيل حول الاجتماع الذي يتم فيه تشغيل الإضافة.
• الطريقة setActivityStartingState() التي تضبط الحالة الأولية للإضافة عندما يقبل المشارك الدعوة للانضمام إلى النشاط.
• للحصول على قائمة شاملة بالميزات في كلا العميلين، اطّلِع على MeetAddonClient الكائن.

الميزات الخاصة بالعميل

الميزات المتوفّرة فقط في الكائن MeetMainStageClient:

• ترسل طريقة notifySidePanel() رسالة إلى اللوحة الجانبية. يمكن تلقّي الرسالة من خلال الاشتراك في frameToFrameMessage الدالة المعالِجة في اللوحة الجانبية.

• يفتح الإطار المتضمّن (iframe) للوحة الجانبية باستخدام طريقة loadSidePanel(). يتم ضبط مصدر iframe على عنوان URL الخاص باللوحة الجانبية من ملف البيان.

• تؤدي الطريقة unloadSidePanel() إلى إغلاق إطار iframe للوحة الجانبية. لا يتم الاحتفاظ بحالة الإضافة ضمن Meet عند استدعاء الطريقة. ويعود إلى الإضافة الاحتفاظ بأي حالة إضافة قبل استدعاء هذه الطريقة.

الميزات المتوفّرة فقط في الكائن MeetSidePanelClient:

• ترسل الدالة notifyMainStage() رسالة إلى mainStage. يمكن تلقّي الرسالة من خلال الاشتراك في السمة frameToFrameMessage الخاصة ببرنامج معالجة المكالمات في المسرح الرئيسي.