BroadcastChannel
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2022.
A interface BroadcastChannel
representa um canal com um nome em que qualquer browsing context (contexto de navegação) de uma determinada origin (origem) pode assinar. Permite a comunicação entre diferentes documentos (em diferentes janelas, abas, frames ou iframes) da mesma origin. As mensagens são transmitidas através de um evento message
acionado em todos objetos do tipo BroadcastChannel
que estão ouvindo o canal.
Note: This feature is available in Web Workers.
Construtor
BroadcastChannel()
-
Cria um objeto, no qual faz o vínculo com um canal nomeado.
Propriedades
Essa interface também herda propriedades de seu pai, EventTarget
.
BroadcastChannel.name
-
Retorna um
DOMString
, o nome do canal.
Event handlers
BroadcastChannel.onmessage
-
Uma propriedade
event handler
que específica a função a ser executada quando um eventomessage
é acionado a este objeto. BroadcastChannel.onmessageerror
-
Uma chamada
event handler
quando umMessageEvent
do tipoMessageError
é disparado - isto é, quando recebe uma mensagem que não pode ser desserializada.
Métodos
Essa interface também herda métodos de seu pai, EventTarget
.
BroadcastChannel.postMessage()
-
Envia a mensagem, de qualquer tipo de objeto, para cada objeto
BroadcastChannel
ouvindo o mesmo canal. BroadcastChannel.close()
-
Fecha o objeto do canal, indicando que ele não receberá novas mensagens e eventualmente será descartado.
Especificações
Specification |
---|
HTML Standard # broadcasting-to-other-browsing-contexts |
Compatibilidade com navegadores
BCD tables only load in the browser
Veja também
- Outra forma mais pesada de comunicação entre browser contexts:
ServiceWorker
. - Visão geral de Broadcast Channel API