Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

addMessageHandler()

Mounts a message handling function, used to handle messages sent from the Aura component to the framed JavaScript app.

Sample

Used within a JavaScript app uploaded as a static resource and referenced by lightning:container, this example mounts a message handling function. In a React app, functions must be mounted to be part of the document-object model and rendered in the output.

1componentDidMount() {
2    LCC.addMessageHandler(this.onMessage);
3}
4
5onMessage(msg) {
6  let name = msg.name;
7  if (name === "General") {
8    let value = msg.value;
9    this.setState({messageReceived: value});
10  }
11  else if (name === "Foo") {
12    // A different response
13  }
14}

Arguments

Name	Type	Description
handler: (userMsg: any) => void	function	The function that handles messages sent from the Aura component.

Response

None.

Lightning Aura Components Developer Guide

addMessageHandler()

Sample

Arguments

Response