LiveMessageSettings

Represents an org’s LiveMessage settings.

This type extends Metadata and inherits its fields.

Introduced in API version 42.0.

LiveMessageSettings values are stored in the LiveMessage.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.

• Type: boolean

• Required: No

• Description: Gives access to ConversationEntry objects only to users with the Access Conversation Entries user permission enabled (true) or to all users (false) in an org.

  For orgs created before API version 50.0, the default value is false.

  For orgs created on or after API version 50.0, the default value is true.

• Type: boolean
• Required: No
• Description: Turns LiveMessage on (true) or off (false) in an org. The default value is false.

The following is an example of a liveMessageSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<LiveMessageSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <enableLiveMessage>true</enableLiveMessage>
4</LiveMessageSettings>

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>LiveMessage</members>
5        <name>Settings</name>
6    </types>
7    <version>44.0</version>
8</Package>

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.