メタデータ API 開発者ガイド
jChatterExtension
ChatterExtension の取得
API ツールを使用して、次のコードによって package.xml から拡張機能の情報を取得できます。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>xw1</members>
5 <name>ChatterExtension</name>
6 </types>
7 <version>41.0</version>
8</Package>特定の拡張機能を指定するには <members> タグを使用し (この例では xw1)、すべての拡張機能を取得するにはワイルドカード (*) 記号を使用します。
次に、取得した情報の例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ChatterExtension xmlns="http://soap.sforce.com/2006/04/metadata">
3 <compositionComponent>xwComp</compositionComponent>
4 <description>des</description>
5 <extensionName>xw1</extensionName>
6 <headerText>h1</headerText>
7 <hoverText>h2</hoverText>
8 <icon>tiger</icon>
9 <masterLabel>primary</masterLabel>
10 <renderComponent>xwRend</renderComponent>
11 <type>Lightning</type>
12</ChatterExtension>バージョン
ChatterExtension は API バージョン 41.0 の新機能です。
項目
| 項目 | 項目の型 | 説明 |
|---|---|---|
| compositionComponent | string | 必須。提供するリッチパブリッシャーアプリケーションのコンポジションコンポーネント。lightning:availableForChatterExtensionComposer インターフェースから構成されます。 |
| description | string | 必須。カスタムリッチパブリッシャーアプリケーションの説明。 |
| extensionName | string | 必須。拡張機能の名前。つまり、リッチパブリッシャーアプリケーションの名前。 |
| headerText | string | アプリケーションコンポーザーのヘッダーに表示するテキスト。ヘッダーテキストは、Lightning 型の拡張機能では必須です。このテキストはローカライズが可能です。 |
| hoverText | string | ユーザーが拡張機能のアイコンに、マウスポインターを重ねたときに表示するテキスト。マウスオーバーテキストは、Lightning 型の拡張機能では必須です。このテキストはローカライズが可能です。 |
| icon | string | 必須。Chatter パブリッシャーに表示するアイコン。組織の既存のファイルアセット ID を使用します。 |
| isProtected | boolean | 自動生成された値。現在、影響はありません。 |
| masterLabel | string | 必須。ChatterExtension オブジェクトの表示ラベル。 |
| renderComponent | string | 必須。提供するリッチパブリッシャーアプリケーションの表示コンポーネント。lightning:availableForChatterExtensionRenderer インターフェースから構成されます。 |
| type | ChatterExtensionType (string 型の列挙) | 必須。拡張機能の種別を記述します。現在サポートされている値は Lightning のみです。今後、他の種別が追加される可能性があります。 |
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳���は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。