Table of Contents

Concierge Links

Patrick Hawley Updated by Patrick Hawley

Concierge Links allows developers to control the behavior of the Concierge Chat interface, and link those behaviors to words or phrases on your website. The API supports adjusting the size of the interface, load text in to the interface, and submitting inquiries. These methods can be utilized to create a speedy and seamless user experience. 

open()

When the Concierge interface is collapsed, the open() method will open the Concierge interface. 

<a href="javascript:void(0)" onclick="window.capacityConcierge.open()">HYPERLINK TEXT</a>

close()

When the Concierge interface is in its default view, the close() method will collapse the Concierge interface to a minimized state. 

<a href="javascript:void(0)" onclick="window.capacityConcierge.close()">HYPERLINK TEXT</a> 

maximize()

The maximize() method will open the Concierge interface to its largest size.

<a href="javascript:void(0)" onclick="window.capacityConcierge.maximize()">HYPERLINK TEXT</a>

load()

The load() method populates the Concierge interface with the text string passed to it.

<a href="javascript:void(0)" onclick="window.capacityConcierge.load('Hello')">Load Concierge with the word Hello</a>

clear()

The clear() method removes any inquiry from the Concierge interface

If text was already loaded in the Concierge interface, this method will clear that text loaded so that the a inquiry can be loaded.  

<a href="javascript:void(0)" onclick="window.capacityConcierge.clear()">HYPERLINK TEXT</a>

submit()

The submit() method submits whatever inquiry is in the Concierge interface.

<a href="javascript:void(0)" onclick="window.capacityConcierge.submit()">HYPERLINK TEXT</a>

ask() 

The ask() method populates and submits the Concierge interface with the text string passed to it. It can be seen as a combination of load() and submit().

<a href="javascript:void(0)" onclick="window.capacityConcierge.ask('CHAT BOX TEXT')">HYPERLINK TEXT</a>

is_open

The is_open boolean property indicates whether the Concierge interface is expanded from its minimized state. Note that this is not the same as the maximized, or largest, size.

if (window.capacityConcierge.is_open) {
// Do things here
}

has_message 

The has_message boolean property indicates whether the Concierge interface contains any content.

if (window.capacityConcierge.has_message) {
// Do things here
}

How did we do?

Commonly Used Concepts

Contact