文档 API参考

活动构建器参考

活动构建器参考

每个SDK活动都有一个构建器()方法，该方法提供使用活动的统一方式。

例子:

             

              
RequestActivity．构建器（）．显示（MyActivity．这）；

本参考文献中的章节:

HelpCenterActivity建设者

的HelpCenterActivityBuilder有以下方法:

显示

启动活动。

参数
的名字 类型 评论
上下文 上下文 应用程序的当前状态
例子
             

              
HelpCenterActivity．构建器（）．显示（MyActivity．这）；

withArticlesForCategoryIds

只显示指定帮助中心类别中的文章。

参数
的名字 类型 评论
被标记 Long或List 一个或多个类别id
例子
             

              
HelpCenterActivity．构建器（）．withArticlesForCategoryIds（112233l，223344l）．显示（MyActivity．这）；

withArticlesForSectionIds

只显示指定的“帮助中心”部分中的文章。

参数
的名字 类型 评论
sectionid Long或List 一个或多个section id
例子
             

              
HelpCenterActivity．构建器（）．withArticlesForSectionIds（112233l，223344l）．显示（MyActivity．这）；

withLabelNames

只显示具有所有指定标签的项目。只有部分标签的文章将被忽略。

参数
的名字 类型 评论
labelNames 字符串或列表<字符串> 一个或多个文章标签
例子
             

              
HelpCenterActivity．构建器（）．withLabelNames（“android”，“android_o”）．显示（MyActivity．这）；

withContactUsButtonVisible

隐藏文章列表视图上允许用户创建票据的浮动操作按钮。

参数
的名字 类型 评论
showContactUsButton 布尔 假隐藏按钮
例子
             

              
HelpCenterActivity．构建器（）．withContactUsButtonVisible（假）．显示（MyActivity．这）；

ViewArticleActivity建设者

的ViewArticleActivity在帮助中心显示特定的文章。构建器有以下参数来指定文章:

的名字 类型 评论
article n .物品 冠词对象或长 要展示的文章

你可以通过文章对象，由API提供程序方法返回以打开文章。看到HelpCenterProvider在支持SDK Javadocs中。

例子:

             

              
ViewArticleActivity．构建器（123l）．显示（MyActivity．这）；

的ViewArticleActivityBuilder有以下方法:

显示

启动活动。

参数
的名字 类型 评论
上下文 上下文 应用程序的当前状态
例子
             

              
ViewArticleActivity．构建器（123l，零）．显示（MyActivity．这）；

withContactUsButtonVisible

隐藏项目上允许用户创建票据的浮动操作按钮。

参数
的名字 类型 评论
contactUsVisible 布尔 假隐藏按钮
例子
             

              
ViewArticleActivity．构建器（123l，零）．withContactUsButtonVisible（假）．显示（MyActivity．这）；

意图

创建一个意图稍后再展示这篇文章。这对于异步操作和Android生命周期问题非常有用。

参数
的名字 类型 评论
上下文 上下文 应用程序的当前状态
例子
             

              
意图viewArticleActivityIntent＝ViewArticleActivity．构建器（）．withContactUsButtonVisible（假）．意图（MyActivity．这）；

配置

创建一个配置对象，该对象可用于配置中显示的所有项目HelpCenterActivity．创建对象后，将其传递给显示方法HelpCenterActivity构建器。

您可以使用以下构建器方法来配置活动:

参数
  • 没有一个
例子
             

              
配置articleConfig＝ViewArticleActivity．构建器（）．withContactUsButtonVisible（假）．配置（）；HelpCenterActivity．构建器（）．显示（MyActivity．这，articleConfig）；

RequestActivity建设者

的RequestActivityBuilder有以下方法:

显示

启动活动。

参数
的名字 类型 评论
上下文 上下文 应用程序的当前状态
例子
             

              
RequestActivity．构建器（）．显示（MyActivity．这）；

withRequestSubject

为票设置一个公共主题。

票据表单没有用户的主题字段。如果不设置主题，则活动使用第一条评论的前51个字符。

参数
的名字 类型 评论
requestSubject 字符串 每张票都有一个共同的主题
例子
             

              
RequestActivity．构建器（）．withRequestSubject（“Android票”）．显示（MyActivity．这）；

withTags

向票据添加一个或多个标签。默认情况下，提交票证时不设置票证标签。

参数
的名字 类型 评论
标签 字符串或列表<字符串> 一个或多个票证标签
例子
             

              
RequestActivity．构建器（）．withTags（“android”，“移动”）．显示（MyActivity．这）；

withFiles

将一个或多个文件附加到票据。

当用户打开附件选择器时，这些文件显示为预选的附件。在提交请求之前，可以取消选择文件。这些文件对于会话流中的最终用户也是可见的。

参数
的名字 类型 评论
文件 文件或列表<文件> 一个或多个File对象
例子
             

              
列表<文件>文件＝.．.；RequestActivity．构建器（）．withFiles（文件）．显示（MyActivity．这）；

withCustomFields

向一个或多个自定义票据字段添加数据。尽管最终用户可以在Help Center的web版本的票据表单中看到自定义字段，但这些字段不能在SDK的对话界面中显示。但是，您仍然可以使用SDK直接设置自定义字段的值。

Zendesk Supp亚博ort的管理员可以添加自定义票务字段到默认的票据表单。自定义字段可以只对代理可见，也可以对代理和最终用户都可见。

先决条件

  • 在Help Center的web版本中，最终用户既可以看到自定义票据字段，也可以对其进行编辑。Ze亚博ndesk管理员可以为您确认或设置这些设置。看到为代理和最终用户添加自定义票据字段在支持帮助中心

  • 您拥有ticket字段的id。要找到它，可以使用票务字段API或者你可以让Zendesk管理员在亚博Zendesk支持中获得它。管理员可以在字段的设置页面上获取id管理>管理>票字段

参数
的名字 类型 评论
customField < CustomField列表> 包含自定义字段的id和要分配给它的值
例子
             

              
CustomFieldcustomFieldOne＝新CustomField（1234567l，“3”）；CustomFieldcustomFieldTwo＝新CustomField（2345678l，“some_text”）；RequestActivity．构建器（）．withCustomFields（数组．asList（customFieldOne，customFieldTwo））．显示（MyActivity．这）；

注意:如果自定义字段值有多个单词，则将该值传递给ZDKCustomField应该被蛇壳化。

withTicketForm

设置票证表单和相关的自定义字段，在Zendesk支持代理界面中使用，以显示与应用程序一起提交的票证。Zendesk支持管理员可以亚博创建不同的票证票形式支持多种请求类型。

Support SDK没有为票据表单提供UI，但是通过这种方法，您可以将自定义字段详细信息以及与之关联的票据表单传递给SDK。根据您的用例，这可能是您通过UI从最终用户收集的信息，也可能是代码中指定的详细信息。

先决条件

  • 您的组织处于Zendesk Suite企业计划或支持企业亚博计划或更高版本

  • Ze亚博ndesk Support管理员已经创建了一个或多个票据表单。看到创建票据表单以支持多种请求类型．

  • 你有机票的id。您可以使用票务表格及API为了得到它。Ze亚博ndesk支持管理员也可以在管理>管理>票形式．

  • 您拥有与该票据表单关联的票据字段的id。Ze亚博ndesk支持管理员可以在这里获取票据表单的字段管理>管理>票形式的ticket字段的id管理>管理>票字段．

  • 您拥有与票据表单关联的票据字段的值。Support SDK没有为票据表单提供UI，因此如果您需要从最终用户那里收集票据表单的详细信息，您必须构建自己的UI来完成这项工作。

参数
的名字 类型 评论
ticketFormId 长 自定义表单的id
customField < CustomField列表> 包含自定义字段的id和要分配给它的值
例子
             

              
CustomFieldcustomFieldOne＝新CustomField（1234567l，“3”）；CustomFieldcustomFieldTwo＝新CustomField（2345678l，“some_text”）；RequestActivity．构建器（）．withTicketForm（1333l，数组．asList（customFieldOne，customFieldTwo））．显示（MyActivity．这）；

withRequestId

显示用户的一张票及其评论。用户可以在对话中添加评论。

此方法用于显示使用请求API提供程序检索到的票据。看到RequestProvider在支持SDK Javadocs中。

请注意:此功能仅在团队、专业和企业计划中可用。

参数
的名字 类型 评论
requestId 字符串 机票的id
例子
             

              
RequestActivity．构建器（）．withRequestId（“123”）．显示（MyActivity．这）；

意图

创建一个意图稍后出示购票表格。这对于异步操作和Android生命周期问题非常有用。

参数
的名字 类型 评论
上下文 上下文 应用程序的当前状态
例子
             

              
意图requestActivityIntent＝RequestActivity．构建器（）．withRequestSubject（“Android票”）．意图（MyActivity．这）；

配置

返回一个配置对象，该对象可用于在其他活动中配置票据表单。创建对象后，将其传递给显示其他活动的方法。

例如，两者RequestListActivity而且HelpCenterActivity允许用户使用票据表单提交请求。要配置它们的票据表单，请创建配置对象的配置设置(主题、标签、文件等)，并将其传递给显示方法，当您启动这些活动时。

您可以使用以下构建器方法来配置票据表单:

参数
  • 没有一个
例子
             

              
配置requestActivityConfig＝RequestActivity．构建器（）．withRequestSubject（“Android票”）．withTags（“android”，“移动”）．配置（）；RequestListActivity．构建器（）．显示（MyActivity．这，requestActivityConfig）；

RequestListActivity建设者

的RequestListActivityBuilder有以下方法:

显示

显示用户的票证列表。点击列表中的一个票证将显示票证对话。用户可以在对话中添加评论。

如果您使用匿名身份，用户只能看到他们在设备上创建的请求。如果你使用匿名身份，用户重新安装应用程序，用户在重新安装之前不会看到他们在设备上创建的任何请求。

先决条件
参数
的名字 类型 评论
上下文 上下文 应用程序的当前状态
例子
             

              
RequestListActivity．构建器（）．显示（MyActivity．这）；