更新记录

1.0.1(2022-10-20)

1.更新ios原生实现到最新版本 2.补充开发说明文档,增加接口api说明

1.0(2022-08-30)

20220830 1.0版本发布

查看更多

平台兼容性

Android Android CPU类型 iOS
适用版本区间:4.4 - 12.0 armeabi-v7a:支持,arm64-v8a:支持,x86:支持 适用版本区间:9 - 15

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


准备工作

  1. 已申请七鱼appkey
  2. 拿到七鱼Uniapp插件包

插件接入(导入步骤若存疑,可以详看Uniapp官网开发文档)

  1. 将插件包导入到Uniapp工程的nativeplugins(如无可以创建)文件夹中
  2. 在manifest.json配置,App原生插件配置-》选择本地插件选项,导入七鱼插件包,并且填入对应的appKey

使用流程

  1. improt七鱼Module,如 var qiyuModule = uni.requireNativePlugin("Netease-QiyuModule")
  2. 调用初始化方法initSdk
  3. 初始化成功后,可以按需调用七鱼api 部分api需要区分android/ios平台传不同参数,故api文档按平台来写,使用可以参考七鱼插件demo工程中的qiyu-module.vue。

API- Android

Api名称与作用同七鱼官方开发文档,点这里链接

  1. initSdk() – 初始化,无回调

  2. setUserInfo({ userId: “”, data: “”, }, () => {}) – 设置用户信息,有回调,该方法以及第一个入参的结构同七鱼官网开发文档:http://qiyukf.com/docs/guide/android/3-CRM对接.html - 上报用户信息

  3. openServiceActivity({ title: '测试界面2', source: { title: 'sse', vipLevel: 1, // 设置用户VIP等级 robotId: 2222, //分配机器人 staffId: 3444, //分配客服 // groupId: 345, //客服组id // groupTmpId: 455, //分流客服组id robotFirst: false, //是否客服组优先 }, }) 方法参数以及作用详见:http://qiyukf.com/docs/guide/android/6-功能配置.html - 商品卡片 ,source的结构同ConsultSource

  4. logout() – 退出登陆

  5. toggleNotification(boolean ) – 推送开关

  6. updateOptions( { isMixSDK: false, logSwitch: false, uiCustomization: { hideLeftAvatar: false, isShowTitleAvatar: true, hideRightAvatar: false, inputTextColor: '#ff5500', }, statusBarNotificationConfig: { showBadge: false, titleOnlyShowAppName: true, } }) – 更新聊天界面配置,即时生效。uiCustomization结构参考 http://qiyukf.com/docs/guide/android/5-自定义样式.html - 聊天窗口自定义

API- iOS

iOS端原生api参考:http://qiyukf.com/docs/guide/ios/2-%E6%8E%A5%E5%85%A5%E8%AF%B4%E6%98%8E.html

uniapp插件提供以下方法配置:

initSdk() 参数:appKey: 七鱼注册的企业唯一标识 appName: 应用名称 pkCerName:PushKit推送证书名;对应云信的pkCername(可以不传)

setUserInfo() 参数:userId:用户唯一标识,如果传空则为匿名用户 data:透传数据,sdk不处理,直接转发给客服端 回调:code:200表示成功,其余表示失败

o penServiceActivity() 参数:titile:客服页面标题 source:配置参数,具体传参格式及说明,参考demo openMode:打开页面的方式push/present,默认push方式

logout() 切换账号时需要调此方法,再调setUserInfo

技术支持

如有疑问,可以联系技术支持:qq - 2265739670

隐私、权限声明

1. 本插件需要申请的系统权限列表:

<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /> <uses-permission android:name="android.permission.INTERACT_ACROSS_USERS"/> <!-- 手机状态 --> <uses-permission android:name="android.permission.GET_TASKS" /> <!-- 读写文件 --> <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

1.3 我们直接收集的信息 1.3.1 为提供发送音频消息功能,我们需获取最终用户的设备麦克风权限,并收集和发送最终用户的语音信息。 1.3.2 为提供发送图片和视频消息功能,我们需获取最终用户的摄像头和相册权限,并收集和发送最终用户的图片和视频信息。 1.3.3 为进行运行环境判断,以便于您排查七鱼在线客服服务运行中出现的问题,我们将收集最终用户的下列信息,包括: 1.3.3.1 设备信息:设备品牌及型号、设备所运行系统版本、名称、编辑版本信息; 1.3.3.2 网络信息:网络状态、wifi信息,IP地址; 1.3.3.3 日志信息:浏览器类型及版本信息、网络连接类型及状态、云信通信服务运行日志信息。 1.3.4 为保障您的账户安全,保证七鱼在线客服服务仅在经您授权的应用中使用,我们将在最终用户的设备收集您开发的IOS应用的Bundle ID及/或您开发的Android应用的应用包名。 1.3.5 为提供更好的语音消息收听体验,在播放语音消息时,我们会收集距离传感器信息,用于感知手机是否被举耳边。

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

作者未提供license.md

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问