getDetailsByPrimaryTabId()

Syntax

sforce.console.chat.getDetailsByPrimaryTabId(primaryTabId:String, callback:Function)

Arguments

Sample Code–Visualforce

<apex:page >
    <apex:includeScript value="/support/console/64.0/integration.js"/>
    <a href="#" onClick="testGetDetailsByPrimaryTabId();">Get Chat Details</a> 

    <script type="text/javascript">

        function testGetDetailsByPrimaryTabId() {
            //Get the value for 'myPrimaryTabId'from the getPrimaryTabIds() or getEnclosingPrimaryTabId() methods. 
            //These values are for example purposes only
            var primaryTabId = 'myPrimaryTabId';
            sforce.console.chat.getDetailsByPrimaryTabId(primaryTabId, getDetailsSuccess);
        }
        
        function getDetailsSuccess(result) {
            //Report whether accepting the chat was succesful
            if (result.success == true) {
                console.log(result);
                chatKey = result.details.chatKey;
                alert('The chatKey for this chat is: ' + chatKey);
            } else {
                alert('Getting the details was not Succesful');
            }
        };

    </script>
</apex:page>

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

details

The details object contains the following properties:

breadcrumb

A breadcrumb represents a Web page viewed by a chat visitor. The breadcrumb object contains the following properties:

customDetail

Custom details are details that have been passed into the chat through the Deployment API or Pre-Chat Form API. The customDetail object contains the following properties:

entityMap

Entities are records that are created when a customer starts a chat with an agent. You can use the API to auto-populate these records with customer details. The entityMap object contains the following properties:

geoLocation

The geoLocation object represents the details of a chat visitor’s location. It contains the following properties:

visitorInfo

The visitorInfo object represents information about the visitor's web browser. It contains the following properties: