Wdrażanie interfejsu Co-Doing API

Interfejs Co-Doing API służy do synchronizowania dowolnych danych między uczestnikami spotkania. Mogą to być dowolne dane, od których zależy działanie aplikacji.

Aby dane mogły zostać przesłane, musisz je zserializować do typu Uint8Array. Więcej informacji znajdziesz w dokumentacji standardowej biblioteki JavaScript.

Jeśli nie wiesz, jak zserializować dane, zapoznaj się z tymi przykładami kodu.

Z tego przewodnika dowiesz się, jak wdrożyć interfejs Co-Doing API.

Rozpocznij

Aby korzystać z interfejsu Co-Doing API, musisz najpierw wdrażać dodatek do Meet. Jednorazowo Gdy już wykonasz te kroki, możesz zacząć korzystać z interfejsu API Co-Doing z poziomu nowego dodatku.

Aby korzystać z interfejsu Co-Doing API, zacznij od pobrania obiektu AddonSession, który służy jako punkt wejścia do współdziałania w Google Meet:

const session = await window.meet.addon.createAddonSession({
    cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});

Utwórz klienta korzystającego ze wspólnego działania

Aby rozpocząć, utwórz obiekt CoDoingClient w sekcji AddonSession.

Aby utworzyć obiekt CoDoingClient, wywołaj metodę createCoDoingClient() i podaj obiekt CoDoingDelegate.

CoDoingDelegate to sposób, w jaki interfejs Co-Doing API aktualizuje Twoją aplikację, gdy tylko pojawi się nowy stan. Kiedy onCoDoingStateChanged() aplikacja natychmiast stosuje nowy stan.

Poniższy przykładowy kod pokazuje, jak korzystać z interfejsu API Co-Doing:

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 the new state to your ongoing CoDoing activity
    },
  });

Zarządzanie bieżącym stanem

Gdy użytkownicy podejmą działanie w aplikacji, powinna ona natychmiast wywołuje broadcastStateUpdate() .

Poniższy przykładowy kod pokazuje implementację metody broadcastStateUpdate():

const myState: MyState = {
  someString: "SOME_STRING",
  someNumber: 0
};

document.getElementById('some-button').onClick(() => {
  myState.someNumber = myState.someNumber + 1;
  coDoingClient.broadcastStateUpdate({ bytes: toBytes(myState) });
});