En esta página, se describe cómo administrar los objetos cliente con los que un complemento necesita comunicarse con Google Meet.
Primero, el complemento debe establecer una sesión:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Reemplaza CLOUD_PROJECT_NUMBER por el número de tu proyecto de Google Cloud.
En la sesión, se pueden crear dos objetos de cliente:
Es el
MeetMainStageClient
de un complemento que se ejecuta en el escenario principal, que se puede recuperar conawait session.createMainStageClient()
.El
MeetSidePanelClient
de un complemento que se ejecuta en el panel lateral, que se puede recuperar conawait session.createSidePanelClient()
.
Es importante recuperar el objeto cliente correcto para el escenario principal o el panel lateral. Si se recupera el cliente incorrecto, el SDK de complementos de Google Meet arroja una excepción. Para verificar en qué iframe (escenario principal o panel lateral) se ejecuta el complemento, usa el método getFrameType()
.
En el siguiente ejemplo de código, se muestra cómo crear una instancia del objeto cliente de la etapa principal:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER"
});
const mainStageClient = await session.createMainStageClient();
Reemplaza CLOUD_PROJECT_NUMBER por el número de tu proyecto de Cloud.
Funciones compartidas
Algunas funciones están disponibles tanto en el objeto MeetMainStageClient
como en el objeto MeetSidePanelClient
, mientras que otras son específicas de un cliente determinado.
Por ejemplo, algunas funciones que están disponibles en ambos clientes incluyen las siguientes:
- El método
getActivityStartingState()
que obtiene información sobre el estado inicial del complemento cuando el participante acepta la invitación para unirse a la actividad. - El método
getMeetingInfo()
que obtiene detalles sobre la reunión en la que se ejecuta el complemento. - El método
setActivityStartingState()
que establece el estado inicial del complemento cuando el participante acepta la invitación para unirse a la actividad. - Para obtener una lista completa de las funciones en ambos clientes, consulta el objeto
MeetAddonClient
.
Funciones específicas del cliente
Funciones disponibles solo en el objeto MeetMainStageClient
:
El método
notifySidePanel()
envía un mensaje al panel lateral. Para recibir el mensaje, suscríbete a la devolución de llamadaframeToFrameMessage
en el panel lateral.El método
loadSidePanel()
abre el iframe del panel lateral. La fuente del iframe se establece en la URL del panel lateral del archivo de manifiesto.El método
unloadSidePanel()
cierra el iframe del panel lateral. El estado del complemento no se conserva en Meet cuando se llama al método. El complemento debe conservar cualquier estado antes de que se llame a este método.
Funciones disponibles solo en el objeto MeetSidePanelClient
:
- El método
notifyMainStage()
envía un mensaje a mainStage. El mensaje se puede recibir si te suscribes a la propiedad de devolución de llamadaframeToFrameMessage
en el escenario principal.