JSDoc: Global

Methods

themeApiReady() → {undefined}

Global callback function which is invoked when the chat application has staged the Theme Api JavaScript libraries. This is the first point in time when the Theme Api is usable by external JavaScript.
This function should be defined in the user-provided JavaScript in a yalst Theme.

Source:

themeApi.js, line 85

Returns:

Type: undefined

Example

function themeApiReady()
    {
      require(['themeApi', 'api'], function(themeApi, sharedRemoteApi)
      {
        themeApi.chatEventPublisher.subscribe("chat", console.log.bind(console));
        themeApi.chatEventPublisher.subscribe("pageChange", console.log.bind(console));

        sharedRemoteApi.isConfiguredPromise.then(function()
        {
          sharedRemoteApi.hello().then(function(helloInfo)
          {
            console.log("The livesupport is now " + helloInfo.chat + ".");
          });
        });
      });
    }

Type Definitions

Api

Ajax api managing the chat on the yalst server

Type:

Object

Properties:

Name	Type	Description
`isISOCodeInstallation`	Boolean
`apiUrl`	String
`fileSizeLimit`	Number
`clientCap`	Number
`isAddressingInformally`	Boolean
`isChatConfiguredForEmojis`	Boolean
`noActivityChatPollingInterval`	Number
`configure`	api.configure	Set up the live support server.
`apiAjaxPromise`	api.apiAjaxPromise	basic method to perform the ajax request to the Chat Api
`hello`	api.hello	Query the availability of the live support service
`mixinPermanentParameters`	function
`notifyApiAjax`	function	polyfill navigator.sendBeacon analytics data push
`notifyLeave`	function	Analytics data push
`leave`	function
`leaveStartForm`	function
`confirmPreChatPresence`	function
`getCoBrowsingUrl`	function
`operatorInfo`	function
`apiAjaxStream`	function
`getContactFormUrlForDepartmentIdAndLanguageNumber`	function

Version:

Copyright:

Source:

api.js, line 1

ChatButtonParameters

exposes static configuration data and web page specific custom data
Created on 22.09.2014 for the yalst-trunk project.

Type:

Object

Properties:

Name	Type	Description
`apiUrl`	String
`bubblePointerClasses`	String
`siteNumber`	String
`department`	string \| undefined
`chatName`	string \| undefined
`pickUpSessionId`	string \| undefined
`pickUpChatId`	string \| undefined
`pickUpDepartmentId`	string \| undefined
`referrer2`	string \| undefined
`languages`	Array.<{code: String, name: String}>	only set if multiple front-end languages are supported
`skipStartForm`	boolean
`chatType`	string \| undefined
`shouldSkipFormsWhenInvited`	boolean
`doNotShowInvitation`	boolean
`showLanguageSwitcher`	Boolean
`invitationTitle`	String
`invitationType`	"invite" \| "auto-invite" \| "load-based-auto-invite" \| "page-logic-invite" \| "no-invitation"
`lang`	String	locale identifier e.g. 'de'
`privacyInfos`	Array.<{code: String, info: String}>
`privacyInfosChatWindow`	Boolean
`customTopImageUrl`	String
`customBottomImageUrl`	String
`isWhiteLabel`	Boolean
`trackingCookie`	String
`yalstAdLink`	String
`resellerBranding`	String
`shouldDisplayFinishedChatConversation`	boolean
`visitorId`	String \| undefined

Version:

Copyright:

Source:

chatButtonParameters.js, line 1