Usar mensagens frame a frame

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. A troca de mensagens frame a frame só ocorre no lado do cliente, então a entrega é quase instantânea.

Para enviar uma mensagem, siga estas etapas:

• Do painel lateral para o palco principal, use o método notifyMainStage().

    await sidePanelClient.notifyMainStage("YOUR_MESSAGE");

• Do palco principal ao painel lateral, use o método notifySidePanel().

    await mainStageClient.notifySidePanel("YOUR_MESSAGE");

O comprimento de payload precisa obedecer ao limite de tamanho especificado.

Para receber a mensagem, o complemento precisa se inscrever no callback frameToFrameMessage (link em inglês). 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 mensagens de frame a frame. 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 quadro a quadro enviadas por um determinado participante ficam visíveis apenas para ele. Para enviar mensagens ou estados a 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 do envio da mensagem.

Temas relacionados

• Implementar a API Co-Doing