Metadata API Developer Guide
jNewer Version Available
LiveChatDeployment
Represents the configuration settings for a
specific Chat deployment, such as the branding image for the deployment and whether or
not chat transcripts are automatically saved.
This type extends the Metadata metadata type and inherits its fullName field.
File Suffix and Directory Location
LiveChatDeployment values are stored in the <developer_name>.liveChatDeployment file in the liveChatDeployments directory.
Version
LiveChatDeployment is available in API version 28.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| brandingImage | string | Specifies the branding image for the deployment. |
| connectionTimeoutDuration | int | Indicates the amount of time before the chat times out, in seconds. |
| ConnectionWarningDuration | int | Indicates the amount of time before a time-out warning is displayed to the agent, in seconds. |
| displayQueuePosition | boolean | (Pilot) Determines whether a customer’s queue position is displayed in a standard chat window while the customer waits for an agent to respond to the chat request (true) or not (false). This field is available as a pilot in API version 32.0. To enable this field, contact Salesforce. |
| domainWhiteList | LiveChatDeploymentDomainWhiteList | Specifies the list of domains that can host the deployment. |
| enablePrechatApi | boolean | Indicates whether or not the pre-chat API is enabled for the deployment (true) or not (false). |
| enableTranscriptSave | boolean | Indicates whether chat transcripts are automatically saved after a chat ends (true) or not (false). |
| label | string | Specifies the name of the deployment. |
| mobileBrandingImage | string | Specifies the branding image for the deployment that appears when customers access the deployment on a mobile device. |
| site | string | Specifies the site that hosts the images for the deployment. |
| windowTitle | string | Specifies the title of the window associated with the deployment. |
Fields
| Field Name | Field Type | Description |
|---|---|---|
| domain | string | Specifies a domain that can host the deployment. |
Declarative Metadata Sample Definition
This is a sample of a liveChatDeployment file.
1<?xml version="1.0" encoding="UTF-8"?>
2<LiveChatDeployment xmlns="http://soap.sforce.com/2006/04/metadata">
3 <label>My Deployment 1</label>
4 <brandingImage>pkb_image_bannerBg</brandingImage>
5 <mobileBrandingImage>pkb_image_bgBottom</mobileBrandingImage>
6 <domainWhiteList>
7 <domain>mydomain</domain>
8 <domain>test</domain>
9 </domainWhiteList>
10 <enableTranscriptSave>true</enableTranscriptSave>
11 <site>GL_Knowledge_Base</site>
12 <windowTitle>My window title</windowTitle>
13</LiveChatDeployment>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.