Live Agent 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

addButtonEventHandler

Use the addButtonEventHandler method to define an automated invitation’s behavior when certain events occur.

Usage

Defines the behavior for an invitation when the following events occur:
  • The criteria are met for the invitation to appear on-screen.
  • The criteria are not met for the invitation to appear on-screen.
  • A customer accepts an invitation to chat.
  • A customer rejects an invitation to chat.

Available in API versions 28.0 and later.

Syntax

void addButtonEventHandler(String buttonId, Function callback)

Parameters

Name Type Description Available Versions
buttonId String The ID of the chat button associated with the automated invitation for which to define the behavior when certain events occur. Available in API versions 28.0 and later.
callback function The function to call when a particular event occurs. You must specify the invitation’s behavior for each of the required event types. Available in API versions 28.0 and later.

Event Types

Incorporate the following event types into your callback function to customize the behavior of your invitation when certain events occur. You must specify the invitation’s behavior for each of the following event types.

Function Event Type Syntax Description
callback BUTTON_AVAILABLE liveagent.BUTTON_EVENT.BUTTON_AVAILABLE Specifies the behavior of the automated invitation when the criteria are met for the invitation to appear on-screen.
BUTTON_UNAVAILABLE liveagent.BUTTON_EVENT.BUTTON_UNAVAILABLE Specifies the behavior of the automated invitation when no agents are available to chat.
BUTTON_ACCEPTED liveagent.BUTTON_EVENT.BUTTON_ACCEPTED Specifies the behavior of the automated invitation when a customer accepts the invitation.
BUTTON_REJECTED liveagent.BUTTON_EVENT.BUTTON_REJECTED Specifies the behavior of the automated invitation when a customer rejects the invitation.