Nesta página, descrevemos como enviar mensagens do lado do cliente de um complemento em execução no iframe do painel lateral para um complemento em execução no iframe do palco principal. As mensagens entre frames ocorrem apenas no lado do cliente, então a entrega é quase instantânea.
Para enviar uma mensagem, siga estas etapas:
- Do painel lateral ao palco principal, use o método
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Do palco principal para o painel lateral, use o método
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
O tamanho de payload precisa estar de acordo com o limite especificado.
Para receber a mensagem, o complemento precisa se inscrever no callback frameToFrameMessage. 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 "Animation" no GitHub
inclui um exemplo completo de mensagens entre frames. Depois que a atividade começa,
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 de frame para frame enviadas por um determinado participante são visíveis apenas para esse mesmo participante. Para enviar mensagens ou estados para outros participantes, saiba como compartilhar o estado do complemento.
A entrega da mensagem é tentada apenas 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.