简单地支持SDK

本页面为您提供了启动和运行Support SDK的基本步骤。

SDK有如下要求:

  • 最低Android版本:API级别21 (Lollipop/5.0)

什么是支持SDK?

支持SDK帮助您添加以下功能到您的应用程序:

  • 显示全部或部分帮助中心内容
  • 搜索帮助中心内容
  • 显示打开的请求
  • 创建请求
  • 更新请求

您可以使用Support SDK为所有这些特性定制用户界面的颜色和字体。看到自定义外观

您也可以在没有我们的UI的情况下使用Support SDK,并在我们的API提供者之上构建自己的UI。这需要更多的开发时间,但可以提供更多的控制。要了解更多信息,请参见API提供者

要查看使用Zendesk移动sdk的不同方式的一些示例,请查看我们的示例应用程序回购亚博Github上

你需要什么开始

  • 您的组织有Zendesk支持帐户。亚博你可以注册开始免费试用。

  • Ze亚博ndesk管理员已在Zendesk Support中注册了您的Android应用程序。看到在Zendesk Support中注册应用程序亚博在支持帮助中心

  • Zend亚博esk管理员已经为您提供了应用程序的初始化代码。该代码是管理员注册应用程序时在Zendesk Support中生成的。

  • 您想要使用的功能包含在Zendesk计划中。亚博看到每个计划的功能和限制的分解

开始工作

  1. 方法中包含以下代码段,将SDK添加到项目中build.gradle文件:

                   
    //注意:这是根级别的存储库容器,而不是'buildScript'下的容器存储库mavenurl“https://亚博zendesk.jfrog.io/zendesk/repo”...依赖关系实现集团“com.亚博zendesk”的名字“支持”版本5.1.1的

    详细信息请参见添加Support SDK

  2. 中初始化Zendesk亚博onCreate ()方法活动你打算在哪里使用SDK应用程序子类。使用Zendesk Support管理员和a提供的初始化详细信息亚博上下文(强调):

                   
    @覆盖公共无效onCreate超级onCreate亚博实例初始化“亚博zendeskUrl”“appId”“clientId”身份身份AnonymousIdentity亚博实例setIdentity身份支持实例初始化亚博实例

    请注意:如果你正在使用多个品牌的子域中,可以使用品牌子域而不是主子域亚博zendeskUrl在上面的代码。请记住,最终用户将只能查看属于该品牌的门票。

  3. 创建一个身份(高亮显示),以便应用程序可以作为Zendesk Support用户进行身份验证,并将此设置为亚博亚博单例模式:

                   
    @覆盖公共无效onCreate超级onCreate亚博实例初始化“亚博zendeskUrl”“appId”“clientId”身份身份AnonymousIdentity亚博实例setIdentity身份支持实例初始化亚博实例

    身份有两种类型:匿名和JWT。详细信息请参见设置标识

  4. 方法初始化支持SDK亚博你刚刚初始化的单例:

                   
    @覆盖公共无效onCreate超级onCreate亚博实例初始化“亚博zendeskUrl”“appId”“clientId”身份身份AnonymousIdentity亚博实例setIdentity身份支持实例初始化亚博实例

Support SDK现在已经初始化,可以使用了。

启动支持SDK界面

Support SDK提供了四种活动类:

  • HelpCenterActivity
  • ViewArticleActivity
  • RequestActivity
  • RequestListActivity

每一个都有一个静态构建器可用于启动活动的方法。例子:

             
RequestActivity构建器显示上下文

您可以在启动活动之前使用构建器对象来配置活动。例子:

             
RequestActivity构建器withRequestSubject“测试支持SDK”withTags“sdk”“android”显示上下文

构造器还可以返回意图对于配置的活动,稍后将启动。这很方便PendingIntentS和其他异步事件。例子:

             
意图requestActivityIntentRequestActivity构建器withRequestSubject“测试支持SDK”withTags“sdk”“android”意图上下文

你甚至可以通过一个活动配置如果其中一个活动启动了另一个活动,则应用到另一个活动。详细信息请参见配置SDK活动

要了解更多信息,请参见添加帮助中心增加门票,以及活动构建器参考

有关全面的参考文档,请参见支持SDK Javadocs在Github上。