Live Agent Developer Guide

About This Guide
Prerequisites
API Versions
Customize Deployments with the Deployment APIs
Create Deployments
Log Deployment Activity with the Deployment APIs
Customize Your Chat Window with the Deployment APIs
Customize Chat Buttons with the Deployment APIs
Find and Create Records Automatically with the Deployment APIs
addCustomDetail
findOrCreate
setName
Search for Knowledge Articles with the Deployment APIs
addCustomDetail.doKnowledgeSearch
Find and Create Records Deployment API Code Sample
Customize Automated Chat Invitations with the Deployment APIs
Deployment API Code Sample
Use Pre-Chat to Gather Visitor Information and Set Context for the Agent
Implement a Custom Chat Window Using Visualforce
Use Post-Chat to Wrap Up the Chat Interaction with Your Customer
Set Up Direct-to-Agent Chat Routing with the Deployment APIs
PDF

Newer Version Available

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

addCustomDetail.doKnowledgeSearch

Use the knowledgeSearch method to automatically search for Knowledge articles based on criteria in a pre-chat form.

Usage

Retrieves a custom detail value from a pre-chat form when a customer requests a chat with an agent. After an agent accepts the chat request, this value is used as a search keyword to find articles in the Knowledge One widget. The doKnowledgeSearch() method conducts a search by using the value parameter in the addCustomDetail method. Available in API version 31.0 and later.

Syntax

liveagent.addCustomDetail(String label, String value, (optional) Boolean displayToAgent).doKnowledgeSearch()