帮助中心API
Web Widget包括一个帮助中心组件,允许用户在组织的帮助中心中搜索答案。表示该组件helpCenter
的对象webWidget
.
设置
的helpCenter
对象具有以下设置:
例子
<脚本类型="text / javascript">
窗口.zESettings={
webWidget:{
helpCenter:{
chatButton:{
fr:“讨论一个人”,
‘*’:“现在和一个人聊天”
}
}
}
};
脚本>
命令
帮助中心组件有如下命令:
helpCenter: setSuggestions
zE('webWidget', 'helpCenter:setSuggestions', options
增强Web Widget提供的上下文帮助。
参数
{url: true}
—在单页面应用中,将URL中的查询参数设置为搜索条件,而不需要最终用户刷新页面。每次要设置建议时都应该调用这个函数。例如,在单页应用程序上导航。{搜索:'搜索字符串'}
—在帮助中心中查找指定的搜索字符串。如果找到结果,则在用户单击Web Widget时将结果显示为首选建议。{标签:['label1']}
-对于使用帮助中心标签的Guide Professional客户,请在帮助中心搜索带有给定标签的文章。如果找到结果,则在用户单击Web Widget时将结果显示为首选建议。
请注意:如果同时传递搜索字符串和标签,则忽略标签。
使用
在Web Widget代码片段之后立即将该方法添加到HTML源代码中。例子:
<脚本类型="text / javascript">
泽(“webWidget”,“helpCenter: setSuggestions”,{搜索:“信用卡”});
脚本>
的zE.setHelpCenterSuggestions ()
方法可以多次调用,这在单页应用程序中非常有用。