Live Agent Developer's Guide

About This Guide
Prerequisites
API Versions
Customize Deployments with the Deployment API
Pre-Chat Forms Overview
Accessing Chat Details with the Pre-Chat API
Create Records Automatically with the Pre-Chat API
Customize Chat Windows with Visualforce
Accessing Chat Details for your Visualforce Chat Window
getDetails
Live Agent Visualforce Components
Live Agent Visualforce Components Code Sample
Post-Chat Pages Overview
Set Up Direct-to-Agent Chat Routing with the Deployment API
PDF

Newer Version Available

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

getDetails

Use the getDetails JavaScript method to access custom details and chat information that have been passed through the Deployment API and Pre-Chat API and incorporate them into your Visualforce chat window.

Usage

Extracts chat information and custom details that have been passed into the chat through the Deployment API and Pre-Chat API and integrates the information into a Visualforce chat window. Call this method within a custom Visualforce chat window.

Call this method when the chat information and custom details change or become available. To verify that these details have become available or have been updated, you need to include the following three required events in the code for your chat window:

You can take a look at how to incorporate these events in the code sample below.

Available in API versions 29.0 and later.

Syntax

liveagent.chasitor.getDetails();

Responses

Name Type Description Available Versions
details Object An object containing all of the custom details to incorporate into your Visualforce chat window. Available in API versions 29.0 and later.
The getDetails method returns a details JavaScript object with a structure similar to the following example object:

Code Sample