使用协作开始状态

本页介绍了 CollaborationStartingState 以及如何通过 Google Meet 插件 SDK 设置和检索该插件。

协作开始状态概览

首次打开某个插件时， 侧边栏 iframe 加载网址 指定的 清单。这个初始 初始状态可能与初始状态 插件想要在用户使用 协作邀请。通过 CollaborationStartingState 可用于指定在用户加入网站时应加载的 iframe 网址 使用协作邀请。此外，additional_data 字段可以是 存储可能需要使用的任何数据 对其进行初始化。

设置、获取和清除协作开始状态

您可以使用以下方法管理 CollaborationStartingState。

使用CollaborationStartingState MeetAddonClient.setCollaborationStartingState 方法。该插件可以在更新前随时设置CollaborationStartingState 或协作期间。

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();