Newer Version Available

This content describes an older version of this product. View Latest

CommunitiesSettings

Represents the feed moderation settings for an org. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

CommunitiesSettings values are stored in the communitiessettings.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Version

CommunitiesSettings components are available in API version 47.0 and later.

Fields

Field Name Field Type Description
canModerateAllFeedPosts boolean When true, allows moderation features, such as flags and rules, to be set on all feed posts including those visible in communities. When set to false, only feed posts in communities can be moderated. Default is false.
canModerateInternalFeedPosts boolean When true, allows moderation features, such as flags and rules, to be set on record feed posts created by internal users, which may also be visible in multiple communities. Default is false.
embeddedVisualforcePages boolean When true, allows links to Visualforce pages from other Visualforce pages in the Salesforce app via the API. Default is false.

Declarative Metadata Sample Definition

The following is an example of a CommunitiesSettings component.

1<CommunitiesSettings xmlns="http://soap.sforce.com/2006/04/metadata">
2    <canModerateAllFeedPosts>true</canModerateAllFeedPosts>
3    <canModerateInternalFeedPosts>true</canModerateInternalFeedPosts>
4</CommunitiesSettings>

The following is an example package.xml that references the previous definition.

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2<types>
3<members>Communities</members>
4<name>Settings</name>
5</types>
6<version>47.0</version>
7</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.