使用协作开始状态

本页介绍了 CollaborationStartingState 的用途,以及如何在 Google Meet 插件 SDK 中设置和检索它。

协作起始状态概览

首次打开插件时,侧边栏 iframe 会加载插件清单中指定的网址。此初始状态可能与用户使用协作邀请加入时插件要使用的起始状态不同。CollaborationStartingState 可用于指定当用户通过协作邀请加入时应加载的 iframe 网址。此外,插件可以使用 additional_data 字段存储其初始化可能需要的任何数据。

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

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

使用 MeetAddonClient.setCollaborationStartingState 方法设置 CollaborationStartingState

MeetAddonClient.setCollaborationStartingState 方法中指定的网址必须与插件清单中指定的来源属于同一来源。如需了解详情,请参阅插件安全性

sidePanelUrlmainStageUrladditionalData 长度必须符合各自的大小限制(如 SDK 参考文档中所发布)。

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

使用 MeetAddonClient.getCollaborationStartingState 方法获取 CollaborationStartingState

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

使用 MeetAddonClient.clearCollaborationStartingState 方法清除 CollaborationStartingState

    mainStageClient.clearCollaborationStartingState();