Esta página descreve como enviar mensagens no lado do cliente de uma em execução na um iframe side-panel a um em execução na interface main estágio. Frame a frame a mensagens só ocorre no lado do cliente, portanto, a entrega da mensagem está próxima instantânea.
Para enviar uma mensagem, siga estas etapas:
- Do painel lateral até o cenário principal, use o
notifyMainStage().
await sidePanelClient.notifyMainStage("YOUR_MESSAGE");
- Para ir do palco principal para o painel lateral, use o
método
notifySidePanel().
await mainStageClient.notifySidePanel("YOUR_MESSAGE");
O payload
deve estar de acordo com o limite de tamanho especificado.
Para receber a mensagem, o complemento precisa estar inscrito em
as
frameToFrameMessage
o retorno de chamada. O exemplo de código a seguir mostra como assinar um
Callback frameToFrameMessage:
sidePanelClient.on('frameToFrameMessage', (arg: FrameToFrameMessage) => {
// YOUR_CODE
});
A página "Animação" complemento de amostra no GitHub
inclui um exemplo completo de mensagens frame a frame. Após o início da atividade,
o painel lateral notifica o cenário principal sempre que o usuário muda uma entrada.
O cenário principal também se inscreve no callback frameToFrameMessage.
para receber o estado atualizado.
Observações
As mensagens frame a frame enviadas por um determinado participante só podem ser vistas pelos o mesmo participante. Para enviar mensagens ou estados para outros participantes: saiba como compartilhar complementos estado.
A entrega da mensagem é tentada apenas uma vez. Para receber mensagens, o servidor deve estar aberto e o aplicativo deve se inscrever no retorno de chamada antes que o mensagem for enviada.