Cobrowse Visitor User Interface API

Cobrowse Visitor User Interface API

The Cobrowse Visitor User Interface API implements methods for displaying elements of the Cobrowse Visitor user interface, such as the Terms and Conditions dialog and the Cobrowse button. You also have the ability to customize the visitor-side user interface.

While most customers will use the "glance-button" attribute to connect web page elements with Glance Cobrowse functionality, for some implementations it is preferable to use the Visitor User Interface API directly.

GLANCE.Cobrowse.VisitorUI

The GLANCE.Cobrowse.VisitorUI object is defined in the standard Glance Cobrowse JavaScript, as long as a custom User Interface has not been specified. VisitorUI exposes methods for displaying the default user interface. See Getting Started for more information on using the default vs. a custom visitor user interface.

Methods

The following methods are available on GLANCE.Cobrowse.VisitorUI:

Method Description
showButton(show)
showButton(show) displays the cobrowse button if show is true. If show is false, it hides the button.
toggleButton()
toggleButton() toggles the display of the cobrowse button.
showTerms(termsParams)
showTerms(termsParams) shows a terms and conditions dialog. The dialog, which is customizable via the cobrowse button customization tool, has an Acceptand a Decline button. Clicking Accept will start a cobrowse session.termsParams is optional and can contain any of the same properties as startParams.
See startSession in the GLANCE.Cobrowse.Visitor section.
setStyle(groupid)
If the page is configured to cobrowse in multiple groups, call setStyle to control which group's cobrowse button customization should be used. If setStyle() is not called, the button customization is selected based on the group passed to showTerms or startSession

By continuing to use the site, you agree to the use of cookies. Learn More