Metadata API Developer Guide
jCustomFeedFilter
File Suffix and Directory Location
CustomFeedFilter components have the suffix .feedFilter and are stored in the feedFilters folder.
Version
CustomFeedFilter components are available in API version 35.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| criteria | FeedFilterCriterion [] | The criterion that defines which feed items are shown when the filter is applied. The feed filter displays all feed items that satisfy the criteria. |
| description | string | The description of the custom feed filter. For example, specify what feed items that filter shows. |
| label | string | Required. The API label of the custom feed filter. |
| isProtected | boolean | An auto-generated value. It currently has no impact. |
FeedFilterCriterion
Represents the conditions that a feed item must satisfy to be displayed when a feed filter is applied.
| Field Name | Field Type | Description |
|---|---|---|
| feedItemType | FeedItemType (enumeration of type string) |
Required. The type of feed items that the filter shows. The feed item type can be one of the following values:
|
| feedItemVisibility | FeedItemVisibility (enumeration of type string) |
The visibility of feed items that the filter shows. For example, you can show only poll posts that are visible internally. Valid values are:
|
| relatedSObjectType | string |
The API name of the object that the feed item refers to. This field is typically used with the CreateRecordEvent feed item type. For example, a feed filter can show CreateRecordEvent feed items for the Cases object. |
Declarative Metadata Sample Definition
The following is an example of a CustomFeedFilter component.
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomFeedFilter xmlns="http://soap.sforce.com/2006/04/metadata">
3 <criteria>
4 <feedItemType>CreateRecordEvent</feedItemType>
5 <relatedSObjectType>MyCO01__c</relatedSObjectType>
6 </criteria>
7 <criteria>
8 <feedItemType>CreateRecordEvent</feedItemType>
9 <relatedSObjectType>Case</relatedSObjectType>
10 </criteria>
11 <criteria>
12 <feedItemType>PollPost</feedItemType>
13 <feedItemVisibility>InternalUsers</feedItemVisibility>
14 </criteria>
15 <label>Sample Custom Feed Filter</label>
16</CustomFeedFilter>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>myCaseFeedFilter</members>
5 <name>CustomFeedFilter</name>
6 </types>
7 <version>66.0</version>
8</Package>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.