En esta página, se describe cómo enviar mensajes al cliente desde un complemento que se ejecuta en la side-panel iframe en un complemento que se ejecuta en la página principal iframe de la etapa. La mensajería de fotograma a fotograma solo se produce en el lado del cliente, por lo que la entrega de mensajes es casi instantánea.
Para enviar un mensaje, sigue estos pasos:
- Desde el panel lateral hasta la escena principal, usa el
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Desde la escena principal hasta el panel lateral, usa el
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
El payload
la longitud debe cumplir con el límite de tamaño especificado.
Para recibir el mensaje, el complemento debe suscribirse a
el
frameToFrameMessage
devolución de llamada. En la siguiente muestra de código, se muestra cómo suscribirse a una devolución de llamada de frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
El complemento de ejemplo "Animation" en GitHub
incluye un ejemplo completo de los mensajes de fotogramas a fotogramas. Después de que comienza la actividad,
El panel lateral notifica a la etapa principal cada vez que el usuario cambia una entrada.
El escenario principal también se suscribe a la devolución de llamada de frameToFrameMessage para recibir el estado actualizado.
Notas
Los mensajes marco a marco enviados por un participante determinado son solo visibles para ese mismo participante. Para enviar mensajes o estados a otros participantes, obtén información sobre cómo compartir el estado del complemento.
Solo se intenta entregar el mensaje una vez. Para recibir mensajes, el panel receptor debe estar abierto y la app debe suscribirse a la devolución de llamada antes de que se envíe el mensaje.