Recupera l'oggetto client

Anteprima per gli sviluppatori: disponibile nell'ambito del Programma Anteprima per gli sviluppatori di Google Workspace, che garantisce l'accesso in anteprima a determinate funzionalità.

Questa pagina descrive come ottenere l'oggetto client di cui un componente aggiuntivo ha bisogno per comunicare con Google Meet.

Innanzitutto, il componente aggiuntivo deve stabilire una sessione:

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

Dalla sessione è possibile creare due oggetti client:

• L'elemento MeetMainStageClient per un componente aggiuntivo in esecuzione nella fase principale, recuperabile utilizzando await session.createMainStageClient().

• L'elemento MeetSidePanelClient per un componente aggiuntivo in esecuzione nel riquadro laterale, recuperabile utilizzando await session.createSidePanelClient().

È importante recuperare l'oggetto client corretto per la fase principale o il riquadro laterale. Se viene recuperato il client sbagliato, l'SDK dei componenti aggiuntivi di Google Meet genera un'eccezione. Per verificare in quale iframe (la fase principale o il riquadro laterale) è in esecuzione il componente aggiuntivo, utilizza il metodo MeetAddon.getFrameType.

Il seguente esempio di codice mostra come creare un'istanza dell'oggetto client della fase principale:

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

Funzionalità condivisa

Alcune funzionalità sono disponibili sia in MeetMainStageClient che in MeetSidePanelClient, mentre altre sono specifiche per un determinato client.

Ad esempio, alcune funzionalità disponibili in entrambi i client includono:

• Il metodo MeetAddonClient.getCollaborationStartingState che riceve informazioni sullo stato iniziale del componente aggiuntivo quando il partecipante accetta l'invito a collaborare.
• Il metodo MeetAddonClient.getMeetingInfo che riceve i dettagli sulla riunione in cui è in esecuzione il componente aggiuntivo.
• Il metodo MeetAddonClient.getMeetPlatformInfo che riceve i dettagli sulla piattaforma riunioni su cui è in esecuzione il componente aggiuntivo.
• L'elemento MeetAddonClient.setCollaborationStartingState che imposta lo stato iniziale del componente aggiuntivo quando il partecipante accetta l'invito a collaborare.
• Per un elenco completo delle funzionalità di entrambi i client, consulta l'oggetto MeetAddonClient.

Funzionalità specifiche del client

Funzionalità disponibili solo in MeetMainStageClient:

• L'icona MeetMainStageClient.notifySidePanel invia un messaggio al riquadro laterale. Il messaggio può essere ricevuto sottoscrivendo il callback frameToFrameMessage nel riquadro laterale.

• Il metodo MeetMainStageClient.loadSidePanel apre l'iframe del riquadro laterale. L'origine dell'iframe è impostata sull'URL del riquadro laterale del file manifest.

• Il metodo MeetMainStageClient.unloadSidePanel chiude l'iframe del riquadro laterale. Lo stato del componente aggiuntivo non viene conservato all'interno di Meet quando il metodo viene chiamato. Spetta al componente aggiuntivo mantenere lo stato prima che venga chiamato.

Funzionalità disponibili solo in MeetSidePanelClient:

• L'elemento MeetSidePanelClient.notifyMainStage invia un messaggio a mainStage. Il messaggio può essere ricevuto mediante l'iscrizione al callback frameToFrameMessage nella fase principale.