この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

LightningMessageChannel

Lightning メッセージチャネルに関連付けられたメタデータを表します。Lightning メッセージチャネルは、UI テクノロジー (Lightning Web コンポーネント、Aura コンポーネント、および Visualforce) 間で通信するための安全なチャネルを表します。

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ファイルのサフィックスおよびディレクトリの場所

LightningMessageChannel コンポーネントのサフィックスは .messageChannel で、messageChannels フォルダーに保存されます。

バージョン

LightningMessageChannel コンポーネントは、API バージョン 47.0 以降で使用できます。

項目

項目名	項目の型	説明
description	string	Lightning メッセージチャネルの説明。
isExposed	boolean	Lightning メッセージチャネルが他の名前空間のコンポーネントに公開されるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。管理パッケージ内にあるか、別のメッセージチャネルコンポーネントによって参照されるメッセージチャネルで `isExposed` を `true` に設定すると、`false` に変更することはできません。他の組織またはコンポーネントがすでにメッセージチャネルに依存しているため、コードが破損する可能性があります。Visualforce による Lightning メッセージチャネルでの `isExposed` の使用については、「Visualforce 開発者ガイド: 考慮事項および制限事項」を参照してください。
lightningMessageFields	LightningMessageField[]	特定の Lightning メッセージチャネルのメッセージペイロード項目のリスト。
masterLabel	string	必須。Lightning メッセージチャネルのラベル。

LightningMessageField

特定の Lightning メッセージチャネルのメッセージペイロード項目を表します。

項目名	項目の型	説明
description	string	Lightning メッセージ項目の説明。
fieldName	string	必須。Lightning メッセージ項目の一意の識別子。

宣言的なメタデータの定義のサンプル

以下は簡単な LightningMessageChannel コンポーネントの例です。

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>

LightningMessageFields を含む LightningMessageChannel コンポーネントの例を次に示します。

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>

前の定義を参照する package.xml の例を次に示します。

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>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド