ChatterExtensions (Pilot)

We provide ChatterExtensions to selected customers through a pilot program that requires agreement to specific terms and conditions. ChatterExtensions is subject to change and isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Note

Represents the metadata used to describe a Rich Publisher App (pilot) that is integrated with the Chatter publisher. ChatterExtensions is a pilot feature in API version 40.0.

Retrieving ChatterExtensions

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>ChatterExtensions</name>
6 </types>
7 <version>40.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<ChatterExtensions xmlns="http://soap.sforce.com/2006/04/metadata">
3  <compComponent>xwComp</compComponent>
4  <description>des</description>
5  <extensionName>xw1</extensionName>
6  <headerText>h1</headerText>
7  <hoverText>h2</hoverText>
8  <icon>tiger</icon>
9  <isBlocked>false</isBlocked>
10  <isEnabled>true</isEnabled>
11  <masterLabel>master</masterLabel>
12  <rendComponent>xwRend</rendComponent>
13  <type>Lightning</type>
14</ChatterExtensions>

Version

ChatterExtensions is a pilot feature in API version 40.0.

Fields

Field	Field Type	Description
compComponent	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, of your Rich Publisher App.
headerText	string	The text to show in the header of your lightning extension composer.
hoverText	string	The text to show when a user mouses over your extension’s icon.
icon	string	Required. The icon to show in the Chatter publisher. Use an existing file asset id from your org.
isBlocked	boolean	If `true`, the extension isn’t be rendered. If `false`, the extension is rendered in the Chatter publisher.
isEnabled	boolean	If `true`, the user can create a feed item with the Chatter extension. If `false`, the user can’t create a feed item with Chatter extension.
isProtected	boolean	An auto-generated value. It currently has no impact.
masterLabel	string	Required. An auto-generated value.
rendComponent	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.
visibilityBits	bit vector	Required. Sets whether the extension appears in Lightning communities or Lightning Experience (OneApp). In this pilot, ChatterExtensions is available only to Lightning communities.

Metadata API Developer Guide

ChatterExtensions (Pilot)

Retrieving ChatterExtensions

Version

Fields

See Also: