Live Agent Developer's Guide

About This Guide
Prerequisites
API Versions
Customize Deployments with the Deployment API
Creating Deployments
Logging Deployment Activity with the Deployment API
Customizing Your Chat Window with the Deployment API
Launching a Chat Request with the Deployment API
Customizing Visitor Details with the Deployment API
addCustomDetail
addCustomDetail.doKnowledgeSearch
setName
Find and Create Records Automatically with the Deployment API
Customizing Chat Buttons with the Deployment API
Customizing Automated Chat Invitations with the Deployment API
Deployment API Code Sample
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
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

addCustomDetail.doKnowledgeSearch

Use the knowledgeSearch method to automatically search for Knowledge One 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()