本页介绍了 CollaborationStartingState
的用途,以及如何通过 Google Meet 插件 SDK 设置和检索它。
协作开始状态概览
首次打开插件时,侧边栏 iframe 会加载插件清单中指定的网址。此初始状态可能与用户使用协作邀请加入时插件要使用的起始状态不同。CollaborationStartingState
可用于指定当用户使用协作邀请加入时应加载的 iframe 网址。此外,该插件还可以利用 additional_data
字段来存储其初始化可能需要的所有数据。
设置、获取和清除协作开始状态
您可以使用以下方法管理 CollaborationStartingState
。
使用 MeetAddonClient.setCollaborationStartingState
方法设置 CollaborationStartingState
。该插件可以在协作之前或协作期间随时设置 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.
})
});
使用 MeetAddonClient.getCollaborationStartingState
方法获取 CollaborationStartingState
。
const startingState = mainStageClient.getCollaborationStartingState();
const additionalData = JSON.parse(startingState.additionalData);
使用 MeetAddonClient.clearCollaborationStartingState
方法清除 CollaborationStartingState
。
mainStageClient.clearCollaborationStartingState();