{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "LightningMessageChannel - Metadata API",
"description": "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.",
"file_information": ".messageChannel",
"directory_location": "messageChannels",
"fields_columns": [
"type",
"description"
],
"fields": {
"description": {
"type": "string",
"description": "The description of the Lightning Message Channel."
},
"isExposed": {
"type": "boolean",
"description": "Indicates whether a Lightning Message Channel is exposed to components in other namespaces (true) or not (false). The default value is false."
},
"lightningMessageFields": {
"type": "LightningMessageField[]",
"description": "A list of message payload fields for a given Lightning Message Channel."
},
"masterLabel": {
"type": "string",
"description": "The label for a Lightning Message Channel.",
"required": true
}
},
"sub_types": {
"LightningMessageField": {
"description": {
"type": "string",
"description": "The description for a Lightning Message Field."
},
"fieldName": {
"type": "string",
"description": "Unique identifier of the Lightning Message Field.",
"required": true
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "Here’s a simple example of a LightningMessageChannel component.",
"code": "\n\n SampleMessageChannel\n true\n This is a sample Lightning Message Channel.\n"
},
{
"description": "Here’s an example of a LightningMessageChannel component with LightningMessageFields.",
"code": "\n\n SampleMessageChannel\n true\n This is a sample Lightning Message Channel.\n \n recordId\n This is the record Id that changed\n \n \n recordData\n The current data representing the record that changed\n \n"
}
]
}