Web Widget API v1

本页记录遗留的zE方法。亚博Zendesk引入了新的命令语法，以获得更大的灵活性。如果您仍在使用这些遗留方法，请考虑迁移到命令语法．

Web Widget API v1由以下方法组成:

您可以使用zE.identify，zE.hide，zE.show,zE.activate方法。例如，您可以在单击事件处理程序中使用它们。

zE.setLocale(地区)

该方法以区域设置字符串作为参数。有关受支持的地区和相关代码的列表，请参见https://support.亚博zendesk.com/api/v2/locales/public.json．

默认情况下，Web Widget以与终端用户的浏览器头相匹配的语言显示给终端用户。如果您想强制小部件在您的网站上以特定语言显示，您可以使用zE.setLocale ()指定语言。

下面的例子显示了小部件的德语版本:

             
              <脚本类型＝＂text / javascript＂>泽（函数（）｛泽．setLocale（“德”）；｝）；脚本>

请注意:这段代码应该放在Web Widget代码片段之后。

zE.identify

zE.identify (userObj)

该方法接受一个JavaScript对象名字，电子邮件可选,组织财产。

如果您可以在web页面上访问最终用户的名称和电子邮件(例如，如果您的用户已登录)，则可以使用zE.identify ()将该用户的详细信息传递到Zendesk支持帐户，以确保您的用户数据是同步的。亚博

它的工作原理是这样的:如果用户的电子邮件在你的Zendesk支持帐户中不存在，则会创建一个包含这些详细信息的新用户记录。亚博

控件中的信息也被使用zE.identify ()调用以预填充联系人或预聊天聊天表单，从而使用户不必输入信息。这对于在移动设备上使用您的网站的最终用户特别有用(下面的截图)。

注意:传递组织与zE.identify ()仅适用于Zendesk Support帐户中的现有组织。亚博它不创建一个新组织。

             
              <脚本类型＝＂text / javascript＂>泽（函数（）｛泽．识别（｛名字：“约翰公民”，电子邮件：＇(电子邮件保护)＇，组织：“贵宾”｝）；｝）；脚本>

中的数据预填充的Widget联系人表单zE.identify ()：

zE.hide

zE.hide ()

该方法对页面完全隐藏了Widget的所有部分。您可以在页面加载之前或之后调用它。

页面加载前

             
              <脚本类型＝＂text / javascript＂>泽（函数（）｛泽．隐藏（）；｝）；脚本>

页面加载后

             
              <按钮onclick＝＂zE.hide ();＂>隐藏Web小部件按钮>

zE.show ()

该方法在主机页上以启动“按钮”状态显示Widget。

例如，当有人登录你的网站时，你可以打电话zE.show ()只对经过身份验证的用户有条件地呈现小部件:

             
              <脚本类型＝＂text / javascript＂>如果（loggedIn）｛泽（函数（）｛泽．显示（）；｝）；｝脚本>

请注意:当Web widget代码片段出现时，小部件将在页面加载时默认显示。你不需要打电话zE.show ()以显示小部件，除非zE.hide ()使用。

zE.activate(选项)

该方法激活并打开Widget的启动状态。启动状态将取决于您如何在Widget管理页面上配置Widget。

例如，当有人点击你网站的“联系”按钮时，你可以打电话zE.activate ()弹出窗口小部件:

参数

选项对象—hideOnClose:如果真正的，在用户关闭小部件后隐藏该小部件，假默认情况下

默认的

             
              <按钮onclick＝＂zE.activate ();＂>联系我们按钮>

与选择

             
              <按钮onclick＝＂zE.activate（｛隐藏OnClose: true});＂>联系我们按钮>

请注意:打电话zE.activate ()还会显示小部件，如果它是隐藏的，你不需要调用吗zE.show ()使用zE.activate ()．

zE.setHelpCenterSuggestions(选项)

该方法增强了Web小部件提供的上下文帮助。

zE.setHelpCenterSuggestions（｛url: true })—在单页面应用中，将URL中的查询参数设置为搜索条件，而不需要最终用户刷新页面。每次要设置建议时都应该调用此函数。例如，在单页应用程序上导航。
zE.setHelpCenterSuggestions（｛搜索：＇搜索string' })—在帮助中心搜索指定的搜索字符串。如果找到结果，当用户单击Web小部件时，将结果显示为顶部建议。
zE.setHelpCenterSuggestions（｛labels: ['label1'] })—对于使用“帮助中心”标签的Guide Professional客户，请在“帮助中心”中搜索具有给定标签的产品。如果找到结果，当用户单击Web小部件时，将结果显示为顶部建议。

请注意:如果同时传递搜索字符串和标签，标签将被忽略。

在HTML源代码中Web Widget代码片段之后立即添加该方法。例子:

             
              <脚本类型＝＂text / javascript＂>泽（函数（）｛泽．setHelpCenterSuggestions（｛搜索：“信用卡”｝）；｝）；脚本>

的zE.setHelpCenterSuggestions ()方法可以多次调用，这在单页应用程序中非常有用。