插件主舞台组件的 MeetAddonClient
。
签名
interface MeetMainStageClient extends MeetAddonClient
遗产
扩展 | MeetAddonClient |
---|
方法签名
名称 | 说明 |
---|---|
closeAddon() |
通过卸载所有 iframe 并关闭侧边栏(如果已打开),关闭在 Meet iframe 中运行的插件。在有活动正在进行时调用此方法不会产生任何影响。 (继承自 MeetAddonClient ) |
endActivity() |
结束持续性活动。在以下情况下,测试会失败:- 没有持续性活动。- 用户不是 activity 的发起者。 (继承自 MeetAddonClient ) |
getActivityStartingState() |
在参与者接受加入活动的邀请时,检索有关插件初始状态的信息。 (继承自 MeetAddonClient ) |
getFrameOpenReason() |
检索导致打开插件框架的操作。 (继承自 MeetAddonClient ) |
getMeetingInfo() |
检索正在运行该插件的会议的相关信息。 (继承自 MeetAddonClient ) |
loadSidePanel() |
打开侧边栏 iframe,并将 iframe 来源设置为插件清单中的侧边栏网址。 |
notifySidePanel(payload) |
从主舞台插件 iframe 向侧边栏插件 iframe 发送消息。在侧边栏 iframe 中运行的插件可以使用 frameToFrameMessage 插件回调来响应此消息。此字符串的长度不得超过 1,000,000 个字符。 |
on(eventId, eventHandler) |
提供对该插件可以使用的 AddonCallbacks 的访问权限。(继承自 MeetAddonClient ) |
setActivityStartingState(activityStartingState) |
设置或更新有关插件初始状态的信息,该信息在参与者接受加入活动的邀请时使用。 (继承自 MeetAddonClient ) |
startActivity(activityStartingState) |
使用所提供的帧起始状态启动 activity,发起者和参与者可在 activity 期间使用。 (继承自 MeetAddonClient ) |
unloadSidePanel() |
关闭侧边栏 iframe。请注意,调用此方法时,侧边栏插件状态不会保留在 Meet 中。如果再次打开侧边栏 iframe(例如调用 loadSidePanel ),系统会将侧边栏 iframe 来源网址设为其在插件清单中的原始值。在调用此方法之前,插件可以自行在插件后端中保留任何插件状态。 |