توضّح هذه الصفحة الغرض من CollaborationStartingState
وكيفية إعدادها واستردادها من خلال حزمة تطوير البرامج للإضافات في Google Meet.
نظرة عامة على حالة بدء التعاون
عند فتح إضافة لأول مرة، يحمّل إطار iframe لللوحة الجانبية عنوان URL المحدّد في بيان الإضافة. قد تكون هذه الحالة الأولية مختلفة عن حالة البدء التي تريد الإضافة استخدامها عند انضمام المستخدمين باستخدام دعوة التعاون. يمكن استخدام
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();