Android SDK V2.x 简介

Android SDK V2.0 及以上版本:

  • 为满足用户更高更深的UI自定义需求,V2.0现已对UI部分开源
  • 支持 bitcode 和国际化

Download SDK and Folk us on GitHub

Android SDK V1.6 及以前版本因存在较大的兼容性问题,请尽快进行升级!
逸创云客服官方将不再为 V1.6 版本以下的 SDK 版本进行兼容性维护,请立即升级至最新SDK版本!

概述

KF5SDK 帮助开发者快速完成开发,目前已支持开发者创建工单、查看工单列表、回复工单、工单满意度评价、查看和搜索知识库文档、即时交谈、推送通知以及国际化英文版支持。目前支持 minSDKVersion14

V2.0 版本的 SDK 较 V1.0 版本主要区别在于:基于 Framework 代码库开发,开源了 UI 和业务逻辑,开发者可以根据自己的需求任意定制不同风格的 UI,使得 SDK 更好与 App 无缝接入,当然开发者也可以使用 SDK 默认的 UI 快速集成;为响应部分开发者对 SDK 中模块精简的需求,V2.0 SDK 现已根据功能模块将源码分成 HelpCenter、Ticket、IM、System 四个包,System 为其他三个包引用的一些必要文件,其他三个包 HelpCenter 目前有联系我们进入到 Ticket 模块、IM 模块默认有入口进入到 Ticket 模块与 HelpCenter 模块、Ticket 模块独立;如果开发者对部分功能暂无需求,可以关闭各自的入口,删掉不需要的功能包;但不提倡这种做法,目前 SDK 已对代码进行了精简处理,对于 Apk 体积压缩可以从打包进行处理。

功能介绍

帮助中心

帮助中心允许用户在 SDK 中根据权限查看和搜索您所注册的云客服平台上的知识库文档

反馈问题/联系我们

用户可以在 SDK 中创建工单(反馈问题),反馈的问题可以在您所注册的云客服平台的后台进行处理

查看工单列表/查看反馈

用户可以查看自己反馈的问题,同时可以回复工单。并且可以通过推送或者工单列表中的红单提示方便及时了解到自己创建的工单已被处理

即时交谈

用户可以通过SDK与机器人或者客服实时交流,机器人回复的内容支持知识库文档查看,实时发送和接收文字消息、语音消息、图片。

集成方法

  1. 先下载 KF5SDK-Android2.0 的官方demo

    注:V2.0 版本的 SDK 基于 AndroidStudio 开发,集成步骤均指 AndroidStudio 的 IDE;若您的 IDE 为 Eclipse,请联系我们并尽快更换 Google 官方的 IDE。
  2. 将 demo 里的kf5sdkModule导入到您的工程中并添加依赖,具体导入步骤请自行查阅相关资料,并将manifest.xml文件里的各种权限以及组件声明拷贝到您的工程下的manifest.xml文件下,若有相关权限可以直接过滤。

    注:使用过 V1.0 版本的 SDK 开发者,之前可能直接使用过 Gradle 远程库依赖直接集成 SDK,V2.0 由于开源了 UI 源码,目前暂不支持 Gradle 远程库依赖,后续将根据开发者反馈情况酌情考虑是否支持 Gradle 远程库依赖,目前所有的集成全部以 Module 导入集成。
  3. 初始化必要信息: [SPUtils.saveHelpAddress(String helpAddress)], [SPUtils.saveAppID(String appID)]

    注:helpAddress即您所注册的逸创云客服平台地址,如 demo.kf5.com;appid为验证是否是您平台的唯一标识,这俩接口需要在对SDK其他操作之前调用。

使用方法

  1. 使用 SDK 的相关功能,需要获取到用户的相关信息,用户信息的相关接口全部封装在 UserInfoApi 中,SDK 除了 loginUser(Map<String, String> fieldMap, HttpRequestCallBack callBack)createUser(Map<String, String> fieldMap, HttpRequestCallBack callBack) 不需要 userToken (用户唯一标示),其他网络请求接口都需要 userToken,所以开发者必须调用两者任意接口先获取到 userToken,然后在调用 [SPUtils.saveUserToken(String userToken)]userToken 保存,方便其他接口调用;每个接口的功能已在注释里做了说明,此处不再描述。

    注:loginUsercreateUserfiledMap 参数说明:由于 SDK 中用户需保证唯一性,所以每次登陆的用户的 email 或者 phone 不同,即 fieldMap 封装的 email 或者 phone 必须不同,否则 App 中的每个用户看到的所有信息全部相同,具体请参考 demo。
  2. Http接口:TicketAPI(工单模块)、HelpCenterAPI(帮助中心模块)、IMAPI(即时交谈)。

  3. SDK 中 Activity 组件说明

    • 帮助中心模块:HelpCenterActivity(文档分区)、HelpCenterTypeActivity(文档分类)、HelpCenterTypeChildActivity(文档列表)、HelpCenterTypeDetailActivity(文档详情)
    • 工单模块:FeedBackActivity(工单反馈)、LookFeedBackActivity(工单列表)、 FeedBackDetailActivity(工单详情)、OrderAttributeActivity(工单属性)、RatingActivity(满意度评价)
    • KF5ChatActivity(即时交谈)
  4. SDK 现已支持滑动返回并默认开启、若需关闭滑动返回则在BaseSwipeBackActivity中设置;开发者若需自定义Activity过渡动画,则在BaseActivity中设置即可

  5. 日志查看,OkHttpManager中设置HttpLoggingInterceptor日志类型。

Framework 包概况

该 jar 包含了核心的工具类、http 请求框架、IM 框架以及 SDK 中必要接口

UI 样式设置

V2.0 SDK 将业务逻辑开源,开发者可根据需求自定义 UI,组件Activity与 xml 视图关系建议从组件Activity入手

第三方库

V2.0依赖的第三方库

compile 'com.google.code.gson:gson:2.7'
compile 'com.alibaba:fastjson:1.2.18'
compile 'com.github.bumptech.glide:glide:3.7.0'