LiveAgentSettings

Represents an organization’s Live Agent settings, such as whether or not Live Agent is enabled. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

LiveAgentSettings values are stored in the LiveAgent.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

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

Version

LiveAgentSettings is available in API version 28.0 and later.

Fields

Declarative Metadata Sample Definition

This is a sample Live Agent settings file.

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