استخدام حالة بدء التعاون

تصف هذه الصفحة الغرض من CollaborationStartingState وطريقة إعداده واسترداده من خلال حزمة تطوير البرامج للإضافات في Google Meet.

نظرة عامة على حالة بدء التعاون

عند فتح إضافة لأول مرة، إطار iframe لللوحة الجانبية يحمِّل عنوان URL المحددة في الإضافة . هذا الاسم الأولي الحالة المختلفة عن حالة البداية التي تريد الإضافة استخدامها عند انضمام المستخدمين التعاون في Google. تشير رسالة الأشكال البيانية CollaborationStartingState يمكن استخدامها لتحديد عناوين URL لإطار iframe التي يجب تحميلها عند انضمام المستخدمين باستخدام دعوة التعاون. أيضًا، يمكن أن يكون الحقل additional_data تستخدمه الإضافة لتخزين أي بيانات قد تحتاجها لإعداده.

ضبط حالة بدء التعاون وتلقّيها ومحوها

يمكنك إدارة CollaborationStartingState باستخدام الطرق التالية.

يمكنك ضبط قيمة CollaborationStartingState باستخدام MeetAddonClient.setCollaborationStartingState . ويمكن لهذه الإضافة ضبط CollaborationStartingState في أي وقت قبل أو أثناء التعاون.

عناوين URL المحدّدة في الطريقة MeetAddonClient.setCollaborationStartingState يجب أن ينتمي إلى المصدر نفسه مثل الأصول المحدّدة في بيان الإضافة. لمزيد من المعلومات، يُرجى مراجعة إضافة الأمان.

تشير رسالة الأشكال البيانية CollaborationStartingState.sidePanelUrl، CollaborationStartingState.mainStageUrl، أو CollaborationStartingState.additionalData يجب أن تتوافق أطوال الأحرف مع حدود الحجم لكل منها كما هو منشور في المستندات المرجعية لحزمة SDK.

    mainStageClient.setCollaborationStartingState({
        sidePanelUrl: "https://app.example.com/sidepanel",
        mainStageUrl: "https://app.example.com/mainstage",
        additionalData: JSON.stringify({
        // State to send to participants.
        })
    });

احصل على CollaborationStartingState، مع MeetAddonClient.getCollaborationStartingState .

    const startingState = mainStageClient.getCollaborationStartingState();
    const additionalData = JSON.parse(startingState.additionalData);

محو CollaborationStartingState، باستخدام MeetAddonClient.clearCollaborationStartingState .

    mainStageClient.clearCollaborationStartingState();