Service Cloud Chat 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
Customize Automated Chat Invitations with the Deployment APIs
setCustomVariable
rejectChat
addButtonEventHandler
Automated Chat Invitation Code Sample
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

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

setCustomVariable

Use the setCustomVariable method to create customized criteria in your sending rules that must be met in order for your automated invitation to be sent to customers.

Usage

Creates customized criteria in your sending rules that must be met in order for your automated invitation to be sent to customers. Specifies the comparison values for custom variables used in criteria for your sending rules. Available in API versions 28.0 and later.

Syntax

void setCustomVariable(String variableName, Object value)

Parameters

Name Type Description Available Versions
variableName String The name of the customized criteria for your custom sending rule. Available in API versions 28.0 and later.
value Object The comparison value for your custom sending rule. Available in API versions 28.0 and later.