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

توضّح هذه الصفحة كيفية إدارة عناصر العميل التي يحتاج إليها أحد الإضافات للتواصل مع 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 الخاصة برد الاتصال في المسرح الرئيسي.