添加帮助中心

添加帮助中心

帮助中心亚博Zendesk指南为您的客户提供基于web的自助服务知识库。亚博官方app您可以使用Support SDK在帮助中心中显示本地化的内容，过滤其内容以使其更有帮助，并将其用作创建票据的起点。

SDK提供了以下两个控制器来将帮助中心添加到iOS应用程序中:

• HelpCenterOverviewController
• ViewArticleController

如果您需要构建自己的ui, SDK还有一个API提供程序，可以让您访问组织的帮助中心。看到帮助中心提供商在API提供程序引用中。

本节涉及的主题:

• 先决条件
• 用户界面概述
• 显示帮助中心
• 按类别筛选文章
• 按节筛选文章
• 按标签筛选文章
• 显示一篇文章
• 配置票据屏幕
• 禁用票据创建
• 禁用文章投票
• 覆盖设备区域设置

先决条件

• Ze亚博ndesk管理员在Zendesk支持中激活了帮助中心。看到激活帮助中心在支持帮助中心

• 知识库中已经发布了一篇或多篇文章亚博官方app

• 已启亚博用Zendesk管理员使指南为您的iOS应用程序在Zendesk支持亚博。看到在Zendesk Support中配置SDK亚博在支持帮助中心

用户界面概述

的默认UIHelpCenterOverviewController如下所示:

要更改UI的外观和感觉，请参见自定义外观．UI不会从基于web版本的帮助中心继承任何样式。

UI以33种语言进行了本地化，并根据设备区域设置选择适当的语言。区域设置必须存在于您的帮助中心和支持帐户本地化设置中。帮助中心中的文章必须经过本地化才能以另一种语言查看。

点击列表中的文章，显示文章内容:

如果用户在帮助中心找不到答案，他们可以点击右上角的铅笔图标来打开一个票务表单:

要配置控制器的票证表单，请参见配置其他SDK控制器的票据形式．

如果你不想要，或者如果你愿意，你可以禁用这张票添加一个单独的票务表格．

显示帮助中心

使用buildHelpCenterOverviewUiWithConfigs方法HelpCenterUi．例子:

斯威夫特

             

              
let helpCenter = HelpCenterUi。buildHelpCenterOverviewUi (withConfigs: [])self.navigationController ?。pushViewController(helpCenter, animated: true)
             

objective - c

             

              
ui＊helpCenter=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［]]；［自我．导航控制器pushViewController：helpCenter动画：是的]；
             

请注意:超过一定数量的文章，由于性能原因，SDK开始限制获取和显示的数量。如果发生这种情况，建议的方法是使用我们提供的各种类别、部分或标签过滤器来限制和控制结果的数量。看到已知的问题．

按类别筛选文章

设置groupid和groupType的性质HelpCenterUiConfiguration．例子:

斯威夫特

             

              
let hcConfig = HelpCenterUiConfiguration()hcConfig。groupType=。categoryhcConfig。groupid=［1234，5678]let helpCenter = HelpCenterUi。buildHelpCenterOverviewUi (withConfigs: [hcConfig])self.navigationController ?。pushViewController(helpCenter, animated: true)
             

objective - c

             

              
ZDKHelpCenterUiConfiguration＊hcConfig=［ZDKHelpCenterUiConfiguration新]；［hcConfig setGroupType：ZDKHelpCenterOverviewGroupTypeCategory]；［hcConfig setGroupIds：@［@1234，@5678]]；ui＊helpCenter=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［hcConfig]]；［自我．导航控制器pushViewController：helpCenter动画：是的]；
             

按节筛选文章

设置groupid和groupType的性质HelpCenterUiConfiguration．例子:

斯威夫特

             

              
let hcConfig = HelpCenterUiConfiguration()hcConfig。groupType=。sectionhcConfig。groupid=［1234，5678]let helpCenter = HelpCenterUi。buildHelpCenterOverviewUi (withConfigs: [hcConfig])self.navigationController ?。pushViewController(helpCenter, animated: true)
             

objective - c

             

              
ZDKHelpCenterUiConfiguration＊hcConfig=［ZDKHelpCenterUiConfiguration新]；［hcConfig setGroupType：ZDKHelpCenterOverviewGroupTypeSection]；［hcConfig setGroupIds：@［@1234，@5678]]；ui＊helpCenter=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［hcConfig]]；［自我．导航控制器pushViewController：helpCenter动画：是的]；
             

按标签筛选文章

设置标签的性质HelpCenterUiConfiguration．例子:

斯威夫特

             

              
let hcConfig = HelpCenterUiConfiguration()hcConfig。标签=［"ios", "xcode"]let helpCenter = HelpCenterUi。buildHelpCenterOverviewUi (withConfigs: [hcConfig])self.navigationController ?。pushViewController(helpCenter, animated: true)
             

objective - c

             

              
ZDKHelpCenterUiConfiguration＊hcConfig=［ZDKHelpCenterUiConfiguration新]；［hcConfig setLabels：@［@“ios”，@“xcode”]]；ui＊helpCenter=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［配置]]；［自我．导航控制器pushViewController：helpCenter动画：是的]；
             

请注意:标签通过AND而不是OR应用于查询。返回的内容必须匹配所有指定的标签。

显示一篇文章

要打开特定的文章，请获取文章的id，然后使用buildHelpCenterArticle．

斯威夫特

             

              
让articleecontroller = HelpCenterUi。buildHelpCenterArticleUi(withArticleId: 123, andConfigs: [])self.navigationController ?。pushViewController(articleController, animated: true)
             

objective - c

             

              
ui＊articleController=［ZDKHelpCenterUi buildHelpCenterArticleUiWithArticleId：123andConfigs：@［]]；［自我．导航控制器pushViewController：articleController动画：是的]；
             

配置票据屏幕

配置设备的票务界面HelpCenterOverviewController这样，每个新票据都有一个共同的主题、共同的标签或共同的文件附件。您还可以为一个或多个自定义票证字段设置通用值，或者设置自定义票证表单以在Zendesk Support的代理界面中使用。亚博

首先，用以下命令配置票据屏幕RequestUiConfiguration．看到配置在增加门票．

第二，传递配置反对andConfigs的参数。ZDKRequestUi功能。

例子:

斯威夫特

             

              
let requestConfig = RequestUiConfiguration()requestConfig。主题="iOS Ticket"let helpCenter = HelpCenterUi。buildHelpCenterOverviewUi (withConfigs: [requestConfig])self.navigationController ?。pushViewController(helpCenter, animated: true)
             

objective - c

             

              
ZDKRequestUiConfiguration＊requestConfig=［ZDKRequestUiConfiguration新]；requestConfig．主题=@“iOS票”；ui＊helpCenter=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［requestConfig]]；［自我．导航控制器pushViewController：helpCenter动画：是的]；
             

禁用票据创建

帮助中心有导航栏按钮，用户可以点击这些按钮打开一个UI来创建一个票据。默认情况下，该按钮在帮助中心文章列表视图和文章视图中都是可见的。您可以将按钮隐藏在一个或两个位置。这是使用HelpCenterUiConfiguration和ArticleUiConfiguration．

在帮助中心禁用票据创建

在Help Center屏幕上，票证创建按钮出现在两个地方:

• 主屏幕上的导航栏
• 无搜索结果时的搜索结果界面

HelpCenterUiConfiguration具有一个布尔属性，用于配置在两个位置中票据创建按钮的可见性。默认为false。用户可根据需要自定义该值。

例子:

斯威夫特

             

              
函数presentelpcenter () {let helpCenterUiConfig = HelpCenterUiConfiguration()helpCenterUiConfig。hideContactSupport=truelet articleUiConfig = ArticleUiConfiguration()articleUiConfig。hideContactSupport = true //隐藏在文章屏幕让helpCenterViewController = HelpCenterUi。buildHelpCenterOverviewUi(withConfigs: [helpCenterUiConfig, articleUiConfig])self.navigationController ?。pushViewController(helpCenterViewController, animated: true)}
             

objective - c

             

              
-（无效）presentHelpCenter｛ZDKHelpCenterUiConfiguration＊helpCenterUiConfig=［ZDKHelpCenterUiConfiguration新]；［helpCenterUiConfig setHideContactSupport：是的]；ZDKArticleUiConfiguration＊articleUiConfig=［ZDKArticleUiConfiguration新]；［articleUiConfig setHideContactSupport：是的]；ui＊控制器=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［helpCenterUiConfig，articleUiConfig]]；［自我．导航控制器pushViewController：控制器的动画：是的]；}
             

在项目视图中禁用票据创建

ArticleUiConfiguration具有一个布尔属性，用于配置条目屏幕上票据创建按钮的可见性。默认为false。用户可根据需要自定义该值。

例子:

斯威夫特

             

              
函数presentArticle() {let articleUiConfig = ArticleUiConfiguration()articleUiConfig。hideContactSupport = true让articleViewController = HelpCenterUi。buildHelpCenterArticleUi(withArticleId: 123, andConfigs: [articleUiConfig])self.navigationController ?。pushViewController(articleViewController, animated: true)}
             

objective - c

             

              
-（无效）presentArticle｛ZDKArticleUiConfiguration＊articleConfig=［ZDKArticleUiConfiguration新]；［articleConfig setHideContactSupport：没有]；ui＊控制器=［ZDKHelpCenterUi buildHelpCenterArticleUiWithArticleId：123andConfigs：@［articleConfig]]；［自我．导航控制器pushViewController：控制器的动画：是的]；}
             

在搜索结果为空后禁用票据创建

集hideContactSupport的性质HelpCenterUiConfiguration．例子:

斯威夫特

             

              
函数presentelpcenter () {let hcConfig = HelpCenterUiConfiguration()hcConfig。hideContactSupport = truelet helpCenter = HelpCenterUi。buildHelpCenterOverviewUi (withConfigs: [hcConfig])self.navigationController ?。pushViewController(helpCenter, animated: true)}
             

objective - c

             

              
-（无效）presentHelpCenter｛ZDKHelpCenterUiConfiguration＊hcConfig=［ZDKHelpCenterUiConfiguration新]；［hcConfig setHideContactSupport：是的]；ui＊helpCenter=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［hcConfig]]；［自我．导航控制器pushViewController：helpCenter动画：是的]；}
             

禁用文章投票

支持SDK中的帮助中心文章投票功能可以由Zendesk支持中的Zendesk管理员启用和禁用。亚博默认为启用状态。看到在Zendesk Support中配置SDK亚博在支持帮助中心。

这一条款的表决完全独立于决议和否决回答机器人，不计入“答疑机器人”的使用。

使用支持SDK与答疑机器人SDK

回答机器人Zen亚博desk提供了一个强大的机制，可以在机票到达代理商之前将其转走。

如果你的应用程序中有Answer Bot 2.0.0和Support 5.0.0(或更高版本)，你可以配置联系人按钮HelpCenterOverviewController和ViewArticleController打开答疑机器人引擎．如果您不提供任何引擎，默认情况下用户将被引导到票证创建。

斯威夫特

             

              
函数presentelpcenter () {{做let answerbotenengine = try answerbotenengine .engine()let helpCenterUiConfig = HelpCenterUiConfiguration()helpCenterUiConfig。引擎=［answerBotEngine]let articleUiConfig = ArticleUiConfiguration()articleUiConfig。引擎=［answerBotEngine]让helpCenterViewController = HelpCenterUi。buildHelpCenterOverviewUi(withConfigs: [helpCenterUiConfig, articleUiConfig])self.navigationController ?。pushViewController(helpCenterViewController, animated: true)} catch {//执行错误操作}}
             

objective - c

             

              
-（无效）presentHelpCenter｛NSError＊错误=零；ZDKAnswerBotEngine＊abEngine=［ZDKAnswerBotEngine engineAndReturnError：零]；NSArray＊引擎=@［（id<ZDKEngine>）abEngine]；ZDKHelpCenterUiConfiguration＊helpCenterUiConfig=［ZDKHelpCenterUiConfiguration新]；helpCenterUiConfig．objcEngines=引擎；ZDKArticleUiConfiguration＊articleUiConfig=［ZDKArticleUiConfiguration新]；articleUiConfig．objcEngines=引擎；ui＊控制器=［ZDKHelpCenterUi buildHelpCenterOverviewUiWithConfigs：@［helpCenterUiConfig，articleUiConfig]]；［自我．导航控制器pushViewController：控制器的动画：是的]；}
             

覆盖设备区域设置

如果你想手动指定获取帮助中心内容时使用的语言，你可以这样做:

斯威夫特

             

              
Support.instance()。helpCenter语言环境Override = ""
             

objective - c

             

              
［ZDKSupport实例]．helpCenterLocaleOverride=@""；
             

如果你只使用API提供者自己构建UI;

斯威夫特

             

              
Support.instance()。helpCenter语言环境Override = ""
             

objective - c

             

              
［ZDKSupport实例]．helpCenterLocaleOverride=@""；
             

这适用于使用UI和提供程序获取的所有Help Center内容，这意味着仅从该区域设置获取文章、部分和类别。这不会更新移动UI元素。语言标签必须全部小写才能工作。覆盖忽略设备区域设置和在Zendesk Guide管理控制台中配置的语言。亚博使用不支持的语言环境或者没有该区域设置的内容将导致“无法连接”横幅。