Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

chasitor.getCustomEvents()

Usage

Retrieves a list of custom events that have been received in this chat window during this chat session. Available in API version 29.0 or later.

Syntax

1liveagent.chasitor.getCustomEvents()

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<a href="#" onClick="testGetCustomEvents();">Get Custom Events</a>
2
3<script type="text/javascript">
4        function testGetCustomEvents() {
5            events = liveagent.chasitor.getCustomEvents();
6            eventsCount = events.length;
7            alert('The following number of custom events have occurred: ' + eventsCount);
8        };
9</script>

Response

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

Name Type Description
events Array of event objects An array of event objects. Each object represents a custom event that has occurred in this chat. Data on each message object can be accessed by the following methods:
  • getType()
  • getData()
  • getSource()
  • getDate()
getType method Accesses the type of the custom event that was sent to this chat window. Returns the type argument of the sforce.console.chat.sendCustomEvent() method used to send this event.
getData method Accesses the data of the custom event that was sent to this chat window. Returns the data argument of the sforce.console.chat.sendCustomEvent() method used to send this event.
getSource method Accesses the source of the custom event that was sent to this chat window—for example, agent or chat visitor.
getDate method Accesses the date of the custom event that was sent to this chat window. Returns the date and time the event was received.