Co-Doing API 用于在会议期间同步任意数据 参与者。这可以是您的应用所依赖的任何数据。
您必须将数据序列化为 Uint8Array
才能传输。对于
请参阅 JavaScript 标准库
参考。
如果您不确定如何序列化数据,请查看代码示例 关注。
本指南介绍了如何实现 Co-Doing API。
开始使用
要使用 Co-Doing API,您必须先构建 Meet 插件。一次 就可以开始使用 Co-Doing API 了 更新插件。
要使用 Co-Doing API,请先获取
AddonSession
,
作为集体活动的入口点:
TypeScript
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
创建 CoDoing 客户端
首先,请创建
CoDoingClient
来自您的 AddonSession
。
如需创建 CoDoingClient
,请调用
AddonSession.createCoDoingClient
方法,并提供一个
CoDoingDelegate
。
CoDoingDelegate
是 Co-Doing API 的运作方式
在应用有可用的新状态时更新它。符合预期
当
CoDoingDelegate.onCoDoingStateChanged
方法时,您的应用会立即应用新状态。
以下代码示例展示了如何使用 Co-Doing API:
TypeScript
interface MyState {
someString: string;
someNumber: number;
}
/**
* Serialize/deserialize using JSON.stringify
* You can use any method you want; this is included for as an example
*/
function toBytes(state: MyState): Uint8Array {
return new TextEncoder().encode(JSON.stringify(state));
}
function fromBytes(bytes: Uint8Array): MyState {
return JSON.parse(new TextDecoder().decode(bytes)) as MyState;
}
const coDoingClient = await addonSession.createCoDoingClient({
activityTitle: "ACTIVITY_TITLE",
onCoDoingStateChanged(coDoingState: CoDoingState) {
const newState = fromBytes(coDoingState.bytes);
// This function should apply newState to your ongoing CoDoing activity
},
});
将 ACTIVITY_TITLE 替换为您的 activity 标题。
管理当前状态
当用户在您的应用中执行操作时,应用应该
会立即调用
CoDoingClient.broadcastStateUpdate
方法。
以下代码示例展示了
CoDoingClient.broadcastStateUpdate
:
TypeScript
const myState: MyState = {
someString: "SOME_STRING",
someNumber: 0
};
document.getElementById('some-button').onClick(() => {
myState.someNumber = myState.someNumber + 1;
coDoingClient.broadcastStateUpdate({ bytes: toBytes(myState) });
});
将 SOME_STRING 替换为应用的当前状态。