Newer Version Available

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

onChatCanceled()

Registers a function to call when a chat visitor cancels a chat request. Available in API version 29.0 or later.

Syntax

Arguments

Name Type Description
callback function JavaScript method called upon completion of the method.

Sample Code–Visualforce

Response

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

Name Type Description
chatKey string The chat key for the chat request that has been canceled.