Questa pagina descrive come gestire gli oggetti client con cui un componente aggiuntivo deve comunicare con Google Meet.
Innanzitutto, il componente aggiuntivo deve stabilire una sessione:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Sostituisci CLOUD_PROJECT_NUMBER con il numero di progetto del tuo progetto Google Cloud.
Dalla sessione possono essere creati due oggetti client:
MeetMainStageClient
per un componente aggiuntivo in esecuzione nella fase principale, recuperabile utilizzandoawait session.createMainStageClient()
.MeetSidePanelClient
per un componente aggiuntivo in esecuzione nel riquadro laterale, recuperabile utilizzandoawait session.createSidePanelClient()
.
È importante recuperare l'oggetto client corretto per lo stage principale
o per il riquadro laterale. Se viene recuperato il client sbagliato, l'SDK per i componenti aggiuntivi di Google Meet genera
un'eccezione. Per controllare in quale iframe (palcoscenico principale o riquadro laterale) viene eseguito il componente aggiuntivo, utilizza il metodo
getFrameType()
.
Il seguente esempio di codice mostra come creare un'istanza dell'oggetto client del palco principale:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER"
});
const mainStageClient = await session.createMainStageClient();
Sostituisci CLOUD_PROJECT_NUMBER con il numero di progetto del tuo progetto Cloud.
Funzionalità condivise
Alcune funzionalità sono disponibili sia nell'oggetto MeetMainStageClient
sia in quello
MeetSidePanelClient
, mentre altre sono specifiche di un determinato
client.
Ad esempio, alcune funzionalità disponibili in entrambi i client includono:
- Il metodo
getActivityStartingState()
che recupera informazioni sullo stato iniziale del componente aggiuntivo quando il partecipante accetta l'invito a partecipare all'attività. - Il metodo
getMeetingInfo()
che recupera i dettagli della riunione in cui viene eseguito il componente aggiuntivo. - Il metodo
setActivityStartingState()
che imposta lo stato iniziale del componente aggiuntivo quando il partecipante accetta l'invito a partecipare all'attività. - Per un elenco completo delle funzionalità di entrambi i client, vedi l'oggetto
MeetAddonClient
.
Funzionalità specifiche per cliente
Funzionalità disponibili solo nell'oggetto
MeetMainStageClient
:
Il metodo
notifySidePanel()
invia un messaggio al riquadro laterale. Il messaggio può essere ricevuto sottoscrivendo ilframeToFrameMessage
callback nel riquadro laterale.Il metodo
loadSidePanel()
apre l'iframe del riquadro laterale. L'origine dell'iframe è impostata sull'URL del riquadro laterale del file manifest.Il metodo
unloadSidePanel()
chiude l'iframe del riquadro laterale. Lo stato del componente aggiuntivo non viene mantenuto in Meet quando viene chiamato il metodo. Spetta al componente aggiuntivo rendere persistente qualsiasi stato prima della chiamata a questo metodo.
Funzionalità disponibili solo nell'oggetto
MeetSidePanelClient
:
- Il metodo
notifyMainStage()
invia un messaggio a mainStage. Il messaggio può essere ricevuto sottoscrivendo la proprietà di callbackframeToFrameMessage
in mainstage.