更新记录

2.0.3.1(2020-01-14)

iOS字典名称修复,同2.0.3

2.0.3(2020-01-14)

V2.0.3更新内容:

1、新增通讯录,获取IM好友列表

2、新增好友模式,基于IM的好友请求,同意,拒绝,好友列表,删除好友,更新好友备注名

3、修复更改用户信息中性别的判断,iOS与Android传参统一,不再区分平台

查看更多

原生插件通用使用流程:

  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原生插件配置”->”云端插件“列表中删除该插件重新选择


功能特性

整体特性

  • 支持消息类型: 文字、图片、语音、地理位置、文件以及自定义消息;
  • 聊天方式:单聊、群聊;
  • 平台:Android & iOS;
  • 用户维护:注册、登录、信息更新;
  • 群组维护:建群、加群和退群;
  • 离线消息:支持离线消息的保存;
  • 关系模式:有好友模式和无好友模式;
  • 跨应用聊天:不同应用下用户可互相通信。

管理控制台

与 JPush 控制台结合,可进行用户和群组的一些基本维护:

  • 创建应用;
  • 注册用户;
  • 管理用户;
  • 维护群组;
  • 发送消息。

APIs

  • 初始化

    • init:初始化插件。建议在应用起始页的构造函数中调用
  • 用户登录、注册及属性维护

    • userRegister:用户注册
    • userLogin:用户登录
    • logout:用户登出
    • getMyInfo:获取当前登录用户信息。如果未登录会返回空对象
    • getUserInfo:获取用户信息。该接口可以获取不同 AppKey 下(即不同应用)的用户信息,如果 AppKey 为空,则默认为当前应用下
    • updateMyPassword:更新当前登录用户的密码
    • updateMyInfo:更新当前登录用户信息。包括了:昵称(nickname)、个性签名(signature)、性别(gender)、生日(birthday)、地区(region)和具体地址(address)
    • updateMyAvatar:更新当前登录用户的头像
  • 聊天

    • sendTextMessage:发送文本消息,注意在第一次发送消息之前,必须先调用 skipToSingleChat 方法
    • sendImageMessage:发送图片消息
    • sendVoiceMessage:发送语音消息,0.5s以上,60s以下
    • getHistoryMessages:从最新的消息开始获取历史消息。当 limit 为 -1 而 from >= 0 时,返回从 from 开始余下的所有历史消息。如果 from 大于历史消息总数,则返回空数组。 例如:当 from = 0 && limit = -1 时,返回所有历史消息
  • 会话

    • skipToSingleChat:创建聊天会话
    • getConversations:从本地数据库获取会话列表。默认按照会话的最后一条消息时间降序排列
    • resetUnreadMessageCount:重置会话的未读消息数
    • deleteConversation:删除聊天会话,同时也会删除本地聊天记录。
    • getAllUnreadCount:获取所有会话未读消息总数
  • 好友

    • getFriends:获取好友列表
    • acceptInvitation:接受申请好友请求,调用后对方会收到 friendInvitiaonChange 事件
    • removeFromFriendList:删除好友,调用成功后对方会收到 friendInvitiaonChange 事件。
    • updateFriendNoteName:更新好友备注名
  • 事件监听

    • receiveMessage: 收到聊天消息
    • clickMessageNotification: 点击消息通知
    • loginStateChanged: 登录状态变更
    • sendMessageResponse: 发送消息结果返回回调
    • friendInvitiaonChange:好友相关事件监听
      • type: 消息类型,可能为:
        • invite_received: 收到好友邀请
        • invite_accepted: 对方接受了你的好友邀请
        • invite_declined: 对方拒绝了你的好友邀请
        • contact_deleted: 对方将你从好友中删除
      • reason: 事件发生的理由。由发起方请求时填写,如果没有填则返回默认字符串
      • fromUser: 事件发起者的用户信息
      • fromUserAppKey: 事件发起者的 AppKey
  • 其他

    • setBadge:设置iOS服务器角标

安装使用

  • 1、在极光官网申请IM的appkey,iOS需配置推送证书
  • 2、选择manifest.json选择原生插件,选择极光IM插件,配置appkey为极光官方后台即可。
  • 3、请下载示例hbx项目,查看更多使用场景
  • 使用方法在static/js/im.js,请下载hbx示例项目即可。

常见问题

  • 问题:Android为何收不到通知栏消息

    答:请在设置 - 通知和状态栏 - 通知管理 - 打开应用名称的悬浮通知/锁屏通知 即可。

  • 问题:iOS角标为什么一直没有置0

    答:请调用setBadge方法,可以监听收到新消息后,调用getAllUnreadCount,回调中再继续调用setBadge即可。

  • 问题:iOS注册以后登录闪退?

    答:调用userLogin方法,请检查传参是否为string,如果password为123455,也请改为:"123456" 即可。

  • 问题:好友发送的所有通知列表在哪?

    好友相关通知事件注意:好友相关事件 SDK 并没有做本地化存储,上层想要做记录这些事件,则需要配合服务端实现存储。详见[IM官方文档](http://docs.jiguang.cn/jmessage/client/ios_sdk/friend/#_14 "IM官方文档")

更多使用方式请咨询作者:398927951

插件交流咨询QQ群号:489296833

体验版下载

Android体验版下载 密码:123456

测试帐号

  • test01 密码 123456
  • test02 密码 123456

隐私、权限声明

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

推送权限 录音权限 相册权限

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

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

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