Metadata API Developer Guide
jNewer Version Available
ChatterExtension
Represents the metadata used to describe a Rich
Publisher App that’s integrated with the Chatter publisher.
Retrieving ChatterExtension
Using Workbench or another API tool, you can get extension information from package.xml using this code.
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>Use the <members> tag to name a specific extension (in this example, xw1), or use the wildcard (*) symbol to retrieve all your extensions.
Here’s an example of retrieved information.
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>Version
ChatterExtension is a new feature in API version 41.0.
Fields
| Field | Field Type | Description |
|---|---|---|
| compositionComponent | string | Required. The composition component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionComposer interface. |
| description | string | Required. The description of your custom Rich Publisher App. |
| extensionName | string | Required. The name of your extension. That is, your Rich Publisher App. |
| headerText | string | The text to show in the header of your app composer. Header text is required for Lightning type extensions. This text can be localized. |
| hoverText | string | The text to show when a user mouses over your extension’s icon. Mouse-over text is required for Lightning type extensions. This text can be localized. |
| icon | string | Required. The icon to show in the Chatter publisher. Use an existing file asset id from your org. |
| isProtected | boolean | An auto-generated value. It currently has no impact. |
| masterLabel | string | Required. Label for the ChatterExtension object. |
| renderComponent | string | Required. The rendering component of the Rich Publisher App that you provide. It’s comprised of the lightning:availableForChatterExtensionRenderer interface. |
| type | ChatterExtensionType (enumeration of type string) | Required. Describes the type of the extension. Currently, the only value supported is Lightning. Included to allow for other possible types in the future. |
Wildcard Support in the Manifest File
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.