LightningMessageChannel

Represents the metadata associated with a Lightning Message Channel. A Lightning Message Channel represents a secure channel to communicate across UI technologies, such as Lightning Web Components, Aura Components, and Visualforce.

This type extends Metadata and inherits its fields.

LightningMessageChannel components have the suffix .messageChannel and are stored in the messageChannels folder.

Introduced in API version 47.0.

• Type: string
• Required: No
• Description: The description of the Lightning Message Channel.

• Type: boolean
• Required: No
• Description: Indicates whether a Lightning Message Channel is exposed to components in other namespaces (true) or not (false). The default value is false.

• Type: LightningMessageField[]
• Required: No
• Description: A list of message payload fields for a given Lightning Message Channel.

• Type: string
• Required: Yes
• Description: Required. The label for a Lightning Message Channel.

Represents a message payload field for a given Lightning Message Channel.

• Type: string
• Required: No
• Description: The description for a Lightning Message Field.

• Type: string
• Required: Yes
• Description: Required. Unique identifier of the Lightning Message Field.

Here’s a simple example of a LightningMessageChannel component.

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningMessageChannel xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>SampleMessageChannel</masterLabel>
4    <isExposed>true</isExposed>
5    <description>This is a sample Lightning Message Channel.</description>
6</LightningMessageChannel>

Here’s an example of a LightningMessageChannel component with LightningMessageFields.

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningMessageChannel xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>SampleMessageChannel</masterLabel>
4    <isExposed>true</isExposed>
5    <description>This is a sample Lightning Message Channel.</description>
6    <lightningMessageFields>
7        <fieldName>recordId</fieldName>
8        <description>This is the record Id that changed</description>
9    </lightningMessageFields>
10    <lightningMessageFields>
11        <fieldName>recordData</fieldName>
12        <description>The current data representing the record that changed</description>
13    </lightningMessageFields>
14</LightningMessageChannel>

Here’s an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>LightningMessageChannel</name>
6    </types>
7    <version>47.0</version>
8</Package>

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.