Presentation: receiver property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only Presentation attribute receiver, which is only available in browser contexts which are receiving a presentation, returns the PresentationReceiver object which can be used to access and communicate with the browser context which controls the presentation. This property is always null when accessed from outside a browser context which is receiving a presentation.

Value

If the code is running in a context which is receiving a presentation, the returned value is a PresentationReceiver which can then be used to communicate with the context which is the source of the presentation.

If the current context is not receiving a presentation, receiver is null.

Examples

Determining whether or not the context is receiving a presentation

You can easily determine whether or not the context is the receiver for a presentation by checking the value of navigator.receiver. If it's a non-null value, then the context is indeed receiving a presentation. If it's null, there's no incoming presentation.

footer.textContent = navigator.receiver ? "Receiving presentation" : "(idle)";

Accessing the connection list

This example uses receiver to access the list of incoming connections and to build and display a list of those connections' ID strings.

const listElem = document.getElementById("connection-view");

navigator.presentation.receiver.connectionList.then((connections) => {
  connections.forEach((aConnection) => {
    listElem.appendChild(document.createElement("li")).textContent =
      aConnection.id;
  });
});

After getting access to the output list element in the variable connectionView, navigator.receiver is used to get a reference to the PresentationReceiver object for this context, and its connectionList is used to get a Promise which will be called when the list is available.

The promise handler receives as its input parameter an array of the incoming connections. We iterate over these using forEach(), appending a new item to the connectionView list element for each connection.

Specifications

Specification
Presentation API # dom-presentation-receiver

Browser compatibility

BCD tables only load in the browser