Newer Version Available
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
| Field Name | Field Type | Description |
|---|---|---|
| enableLiveAgent | boolean | Indicates whether Live Agent is enabled (true) or not (false). |
Declarative Metadata Sample Definition
This is a sample Live Agent settings file.