openIM

来自于：开发者

initYWIMKit login openConversationActivity openChattingActivity openTribeChattingActivity logout

概述

阿里百川即时通信服务

百川云旺（OpenIM）是阿里巴巴推出的移动端IM开放服务，专注为移动应用开发者提供免费的即时通讯基础能力（百川云旺·即时通讯）。

通过集成云旺（OpenIM），开发者不必搭建服务端硬件环境，就可以将即时通讯快速集成至应用中。

openIM 模块概述

本模块只简单封装了阿里百川即时通信开放平台的原生 SDK，集成了登录、带UI的单聊、群聊功能，支持发送文字，图片，语音；轻松、高效集成百川即时通信功能到自己的 app 内。复杂功能未集成后续继续开发完善。

模块使用攻略

使用之前须从阿里百川开放平台申请开发者账号并创建应用，获取 AppKey。

阿里百川平台接入流程参考开发者入驻文档

使用此模块之前建议先配置config.xml文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：openIM
  • 参数：AppKey_Android、AppKey_iOS、PushCertName
  • 配置示例:
  1.   <feature name="openIM">
  2.     <param name="AppKey_Android" value="24652423"/>
  3.     <param name="AppKey_iOS" value="24652423"/>
  4.     <param name="PushCertName" value="20171013test"/>
  5.   </feature>
  • 字段描述:
  1. **AppKey_Android**：（必须配置）从阿里百川开放平台获取的 AppKey（iOS和Android暂时配置相同，跨应用通信未测试，后续升级跨应用通信）。
  3. **AppKey_iOS**：（必须配置）从阿里百川开放平台获取的 AppKey（iOS和Android暂时配置相同，跨应用通信未测试，后续升级跨应用通信）。
  5. **PushCertName**：设置苹果推送账号关联的证书名称，参考：[APNS推送](http://baichuan.taobao.com/docs/doc.htm?spm=a3c0d.7629140.0.0.bWMrUj&treeId=55&articleId=103420&docType=1)。

iOS 系统平台上需注自己申请yw_1222.jpg安全图片，申请后请下载alibaichuanym模块替换yw_1222图片，进行自定义模块上传。

模块接口

initYWIMKit

初始化阿里百川即时通信

initYWIMKit({params}, callback(ret, err))

params

title：

  • 类型： JSON对象
  • 描述：（可选项）自带聊天UI顶部菜单颜色配置。

  • 内部字段：

    1. {
    2.   color : '#000000',       //标题字体颜色,默认颜色:#000000
    3.   background : '#48C997'  //标题栏背景色,默认颜色:#48C997
    4. }

userid：

  • 类型：字符串
  • 描述：（必填项）初始化当前登陆账号。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code : -1,
  3.     msg : ''
  4. }

示例代码

  1. var demo = api.require('openIM');
  2. demo.initYWIMKit({
  3.     title : {
  4.         color : '#000000',       //标题字体颜色
  5.         background : '#48C997'  //标题栏背景色
  6.     },
  7.     userid : '111111'
  8. },function(ret, err){
  9.     alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
  10. });

补充说明

请参考服务端集成说明开发服务端，进行申请用户账号等。接口操作远程测试地址

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

login

即时通信登陆

login({params}, callback(ret, err))

params

password：

  • 类型：字符串
  • 描述：（必填项）用户密码。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code : -1,
  3.     msg : ''
  4. }

示例代码

  1. var demo = api.require('openIM');
  2. demo.login({
  3.     password : '123456'
  4. },function(ret, err){
  5.     alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
  6. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openConversationActivity

打开会话列表

openConversationActivity(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     evenType : 'show' //打开事件show|close
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code : -1,
  3.     msg : ''
  4. }

示例代码

  1. var demo = api.require('openIM');
  2. demo.openConversationActivity(function(ret, err){
  3.     alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openChattingActivity

打开普通单聊界面

openChattingActivity({params}, callback(ret, err))

params

target：

  • 类型：字符串
  • 描述：（可选项）消息接收着账号ID。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     evenType : 'show' //打开事件show|close
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code : -1,
  3.     msg : ''
  4. }

示例代码

  1. var demo = api.require('openIM');
  2. demo.openChattingActivity({
  3.     target : '222222'   //消息接收者账号ID
  4. },function(ret, err){
  5.     alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
  6. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

openTribeChattingActivity

打开群聊天界面

openTribeChattingActivity({params}, callback(ret, err))

params

tribeId：

  • 类型：字符串
  • 描述：（必填项）群ID号。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true,   //布尔型；true||false
  3.     evenType : 'show' //打开事件show|close
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code : -1,
  3.     msg : ''
  4. }

示例代码

  1. var demo = api.require('openIM');
  2. demo.openTribeChattingActivity({
  3.     tribeId : '2331359524'
  4. },function(ret, err){
  5.     alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
  6. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

logout

登出

logout(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true   //布尔型；true||false
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code : -1,
  3.     msg : ''
  4. }

示例代码

  1. var demo = api.require('openIM');
  2. demo.logout(function(ret, err){
  3.     alert(JSON.stringify(ret)+"  "+JSON.stringify(err));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本