實作 Co-Doing API

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 替換成活動標題。

管理目前狀態

當使用者在您的應用程式中採取行動時，應用程式應該也會 會立即呼叫 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 替換成應用程式目前的狀態。