Esta página descreve como enviar mensagens no lado do cliente de um complemento em execução no painel lateral iframe para um complemento em execução no palco principal iframe. A troca de mensagens entre frames só ocorre no lado do cliente, então a entrega de mensagens é quase instantânea.
Para enviar uma mensagem, siga estas etapas:
- Do painel lateral para o palco principal, use o
notifyMainStage()método.
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Do palco principal para o painel lateral, use o
notifySidePanel()método.
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
O payload
comprimento precisa estar de acordo com o limite de tamanho especificado.
Para receber a mensagem, o complemento precisa se inscrever no
the
frameToFrameMessage
callback. O exemplo de código a seguir mostra como se inscrever em um callback frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
O complemento de exemplo "Animação" no GitHub
inclui um exemplo completo de troca de mensagens entre frames. Depois que a atividade é iniciada,
o painel lateral notifica o palco principal sempre que o usuário muda uma entrada.
O palco principal também se inscreve no callback frameToFrameMessage
para receber o estado atualizado.
Observações
As mensagens entre frames enviadas por um participante são visíveis apenas para ele. Para enviar mensagens ou estados a outros participantes, aprenda a compartilhar o estado do complemento.
A entrega de mensagens só é tentada uma vez. Para receber mensagens, o painel de recebimento precisa estar aberto, e o app precisa se inscrever no callback antes que a mensagem seja enviada.