文档 API参考

从Chat小部件语法迁移

从Chat小部件语法迁移

本文描述了如何从Chat小部件语法迁移到统一的Web小部件(经典)语法。

绝大部分遗产zopim.livechat美元api有别名，因此它们将继续工作，而不需要更新任何代码。

在某些情况下，与聊天小部件相比，Web小部件(经典)中的api的行为方式可能存在细微差异。例如，Web Widget在其启动器和窗口之间没有任何分离，因此如果您调用隐藏或setOffset它应用于整个小部件，而不仅仅是启动器或窗口。有关更多细节，请参阅下面每个API的说明。

如果您打算继续使用zopim.livechat美元语法，然后迁移到新的泽语法，请参考使用聊天小部件JavaScript API在Zendes亚博k帮助中心了解如何正确包装zopim.livechat美元使用时调用API泽．

要阅读每个API的详细描述，请参阅Web Widget(经典)开发人员文档．

通用api

zopim.livechat美元syntax 泽语法
进行身份验证 zESettings.webWidget.authenticate.chat
badge.hide 泽(“webWidget”、“隐藏”)
badge.show 泽(“webWidget”,“显示”)
button.hide 泽(“webWidget”、“隐藏”)
button.show 泽(“webWidget”,“显示”)
endChat 泽(' webWidget ', '结束聊天:')
hideAll 泽(“webWidget”、“隐藏”)
isChatting 泽(' webWidget: ', '聊天:isChatting ')
addTags zE('webWidget'， '聊天:addTags'， array)
removeTags zE('webWidget'， '聊天:removeTags'， array)
说 zE('webWidget'， 'chat:send'， msg)
组* zE('webWidget'， 'prefill'， data)而且zE('webWidget'， 'setLocale'， data)
setDefaultImplicitConsent zESettings.cookies
setLanguage zE('webWidget'， 'setLocale'， data)
window.popout 泽(' webWidget ', '可以')
window.toggle 泽(“webWidget”、“切换”)
window.hide 泽(“webWidget”、“隐藏”)
window.show * 泽(“webWidget”、“开放”)
window.getDisplay 泽(' webWidget: ', '显示')

＊$ zopim.livechat.set ()目前支持以下api:名称，电子邮件和语言。＊$ zopim.livechat.window.show ()默认情况下将在小部件中显示聊天产品。

访客信息

zopim.livechat美元syntax 泽语法
setName * zE('webWidget'， 'prefill'， {name: {value: 'John Doe'， readOnly: true|false}})
setEmail * zE('webWidget'， 'prefill'， {email: {value: '(电子邮件保护)'， readOnly: true|false}})
setPhone * zE('webWidget'， 'prefill'， {phone: {value: '12345678'， readOnly: true|false}})
sendVisitorPath 泽(“webWidget”、“updatePath”)
clearAll 泽(“webWidget”、“注销”)

*您可以使用新的预填充API同时设置姓名，电话和电子邮件。若要同时设置多个属性，请提供一个预填充对象，其中每个属性都有一个键。例子:

             

              
泽（“webWidget”，“预先填充”，｛的名字：｛.．.｝，电子邮件：｛.．.｝，电话：｛.．.｝｝）

事件

zopim.livechat美元syntax 泽语法
setOnConnected zE('webWidget:on'， 'chat:connected'， () => {})
setOnChatStart zE('webWidget:on'， 'chat:start'， () => {})
setOnChatEnd zE('webWidget:on'， 'chat:end'， () => {})
setOnStatus zE('webWidget:on'， 'chat:status'， (status) => {})
setOnUnreadMsgs zE('webWidget:on'， 'chat:unreadMessages'， (msgs) => {})
window.onShow zE('webWidget:on'， 'open'， () => {})
window.onHide zE('webWidget:on'， 'close'， () => {})

自定义的api

zopim.livechat美元syntax 泽语法
badge.setColor zESettings.webWidget.color.launcher
badge.setLayout zESettings.webWidget.launcher.badge.layout
badge.setImage zESettings.webWidget.launcher.badge.image
badge.setText zESettings.webWidget.launcher.badge.label
button.setOffsetVertical zESettings.webWidget.offset.vertical
button.setOffsetVerticalMobile zESettings.webWidget.offset.mobile.vertical
button.setOffsetHorizontal zESettings.webWidget.offset.horizontal
button.setOffsetHorizontalMobile zESettings.webWidget.offset.mobile.horizontal
button.setPosition * zESettings.webWidget.position
button.setPositionMobile * zESettings.webWidget.position
button.setColor zESettings.webWidget.color.launcher
button.setOffsetBottom zESettings.webWidget.offset.vertical
window.setColor zESettings.webWidget.color.theme
window.setTitle zESettings.webWidget.chat.title
window.setOffsetVertical zESettings.webWidget.offset.vertical
window.setOffsetHorizontal zESettings.webWidget.offset.horizontal
window.setOffsetBottom zESettings.webWidget.offset.vertical
window.setPosition * zESettings.webWidget.position
prechatForm.setGreetings zESettings.webWidget.chat.prechatForm.greeting
offlineForm.setGreetings zESettings.webWidget.chat.offlineForm.greeting
mobileNotifications.setDisabled zESettings.webWidget.chat.notifications.mobile.disable
theme.setColor * zESettings.webWidget.color.theme
theme.setColors * zESettings.webWidget.color.theme
theme.setProfileCardConfig zESettings.webWidget.chat.profileCard.avatar，zESettings.webWidget.chat.profileCard.title，zESettings.webWidget.chat.profileCard.rating
setDisableGoogleAnalytics zESettings.analytics
setGreetings zESettings.webWidget.launcher.chatLabel
setStatus 的zopim.livechat美元支持语法。但是，它没有映射到统一的Web Widget API
button.setHideWhenOffline zESettings.webWidget.chat.hideWhenOffline

*所有的位置值支持在传统聊天小部件可以使用除了tm(上中)，以及bm(底部的中间)。中位置值的完整列表遗留聊天文档．还要注意，设置移动或桌面的位置将同时影响web小部件的移动和桌面版本。

＊zopim.livechat.theme.setColor美元只支持原色。

＊zopim.livechat.theme.setColors美元只支持原色。

礼宾部

zopim.livechat美元syntax 泽语法
concierge.setAvatar zESettings.webWidget.chat.concierge.avatarPath
concierge.setName zESettings.webWidget.chat.concierge.name
concierge.setTitle zESettings.webWidget.chat.concierge.title

部门

zopim.livechat美元syntax 泽语法
departments.filter zESettings.webWidget.chat.departments.enabled
departments.setVisitorDepartment zESettings.webWidget.chat.departments.select
departments.clearVisitorDepartment zESettings.webWidget.chat.departments.select
departments.getDepartment zE('webWidget:get'， '聊天:部门'，id或名称)
departments.getAllDepartments 泽(' webWidget: ', '聊天:部门”)
departments.setLabel zESettings.webWidget.chat.prechatForm.departmentLabel

哪些api不受支持

下面是$zopim的列表。Web小部件(经典)中不支持的livechat api。

弃用

zopim.livechat美元syntax 笔记
setDisableSound 管理设置已经取代了这一需求
setNotes 出于安全原因不再支持
appendNotes 如上所述
bubble.show 不再支持聊天气泡功能
bubble.hide 如上所述
bubble.reset 如上所述
bubble.setTitle 如上所述
bubble.setText 如上所述
bubble.setColor 如上所述
getName 由于在独立的聊天小部件中这些api的使用率很低，所以它们不会迁移到新的体验中。如果这阻碍了你的用例，请在下面的评论中告诉我们你想要实现什么。
getEmail 如上所述
getPhone 如上所述
setSize 如上所述
theme.reload 主题API调用是自动应用的，不需要后续调用
theme.setFontConfig 聊天主题不再可用
theme.setTheme 如上所述
cookieLaw.comply Cookie法律格式正在改变