uexEasemob查看3.0文档

1、简介
2、API概览
3、附录
4、更新历史
1、简介
环信插件

本文的目的是为了开发能够更好更快地将API集成到自己的项目中，在使用前最好先使用好我们提供的demo并对照文档运行看看效果。
这里可以【参考教程】下载AppCan IDE为开发者工具开发，然后集成到自己的项目上。

1.1、说明

本插件是基于环信API封装的AppCan平台的插件模块,用户可以使用本插件实现基本的即时通讯功能,包括——

单聊功能：支持发送语音,图片,表情,文字,位置,附件;
群聊功能：支持500人到2000人大群,拥有完善的群组权限管理;
实时语音：基于IP网络的点对点实时语音,适应低带宽要求;
客服功能(iOS 3.0.22, Android 3.0.23及以上支持):基于新一代移动互联网技术的全媒体智能客户关系中心系统,详情见环信移动客服文档
支持华为推送功能；查看使用说明

使用前说明:

本插件为单例插件 ——

在任何网页调用本插件,调用的是同一个插件实例;
所有的API都是异步方法,不会直接返回值;
所有的回调都会传到"root页面"(config.xml中配置的App起始页面即为root页面)

以上内容非常重要

root页面收到回调后,可以通过uexWindow的相关方法传递到各个网页去, 以下方法是您可能要用到的——

 传递给某个窗口
uexWindow.evaluateScript;
uexWindow.evaluatePopoverScript
uexWindow.evaluateMultiPopoverScript
 传递给某些窗口:
uexWindow.publishChannelNotification
uexWindow.subscribeChannelNotification

这些方法具体用法在uexWindow文档内有描述,当然,也可下载Demo 参考Demo内的调用.

1.2、 UI展示

暂无

1.3、开源源码

插件测试用例与自定义插件下载:点击此处(插件测试用例与插件源码已经提供)

1.4、术语表

Path Types

协议头	Android对应路径 (其中"/sdcard/"等同于"/storage/emulated/0/")	iOS对应路径
res://	widget/wgtRes/	widget/wgtRes
wgts://	/storage/emulated/0/widgetone/apps/ xxx(widgetAppId)/	/Documents/apps/xxx(widgetAppId)/
wgts://	/storage/emulated/0/widgetone/widgets/	/Documents/widgets/
file:///sdcard/	/storage/emulated/0/	无

1.5、平台版本支持

本插件的所有API默认支持Android4.0+和iOS7.0+操作系统.

有特殊版本要求的API会在文档中额外说明.

1.6、接口有效性

本插件所有API默认在插件版本4.0.0+可用.

在后续版本中新添加的接口会在文档中额外说明.

1.7、接入小米推送（环信目前已经不支持）

正常情况下应用在小米手机上被杀之后是无法收到消息的，现在可以通过接入小米推送来收消息，步骤如下：

• 进入小米推送的后台，创建一个应用，完成后得到 AppID、AppKey、AppSecret。然后，登录环信管理后台，选择你的应用—>选择推送证书—>Xiaomi—>新增证书。

证书名称为刚从小米推送后台拿到的 AppID，证书密钥为 AppSecret，以及填上你当前应用的包名，点击上传即可。
• 打包勾选小米推送
• uexEasemob.initEasemob增加参数miPushAppId miPushAppKey

• config.xml 添加配置（以下配置只用更改“此处填写你的包名“为你的包名，其他不要更改）

<config desc="uexMiPush" type="KEY">
      <param name="$packageName$" platform="Android" value="此处填写你的包名"/>
</config>
<config desc="uexMiPush" type="KEY">
    <param name="org.zywx.wbpalmstar.plugin.uexmipush.MiBroadcastReceiver" platform="Android" value="com.hyphenate.chat.EMMipushReceiver"/>
</config>

1.8、接入华为推送

正常情况下应用在华为手机上被杀之后是无法收到消息的，现在可以通过接入华为推送来收消息，步骤如下：

• 进入华为开发者后台，创建一个应用，完成后配置push权益。创建完成后，会自动生成的APP ID及APP SECRET，进入环信管理后台，选择你的应用—>选择推送证书—>Huawei—>新增证书。

证书名称为刚从华为后台拿到的 APP ID，证书密钥为 APP SECRET，点击上传即可。
• 打包勾选华为推送（特别说明：如果应用有百度地图的插件，需要使用华为推送无百度地图版本的，否则会打包失败）
• uexEasemob.initEasemob增加参数huaweiPushAppId

• config.xml 添加配置

<config desc="uexHuaweiPush" type="KEY">
        <param name="org.zywx.wbpalmstar.plugin.uexhuaweipush.MyReceiver" platform="Android" value="com.hyphenate.chat.EMHuaweiPushReceiver"/>
</config>

• 所有发送消息的接口都添加了ignoreNotification(bool类型，发送静默消息)、forceNotification(bool类型，发送强制推送)、pushTitle(String类型，自定义推送的标题)对应于http://docs.easemob.com/im/200androidclientintegration/115thirdpartypush 三种华为推送类型。

2、API概述

2.1、Initialization

initEasemob(param,function(data){}) //初始化

说明:

初始化环信SDK

调用环信其他任意接口前必须先保证已调用此方法
在整个应用生命周期中,此方法只需调用一次即可

param为json字符串

  var param{
    appKey:,//区别app的标识   
    apnsCertName:,//iOS中推送证书名称(仅iOS)
    isAutoLoginEnabled:,//可选参数 是否开启自动登录功能 1-开启 2-关闭
    isAutoAcceptGroupInvitation:,//可选参数 是否开启用户自动同意群邀请, 1-开启 2-关闭 默认为开启(此参数为3.0.22后新加入)
    miPushAppId:,//String类型 可选 小米推送的appId
    miPushAppKey:,//String类型 可选 小米推送的appKey
    huaweiPushAppId:,//String类型 可选 华为推送的appId//仅支持android
};
* apnsCertName不传时,无法使用环信的APNs推送功能

* 注：接入小米安卓推送时，由于环信目前已经不支持，此功能暂废弃，可以接入华为推送。

data为json字符串

var data = "EaseMobSDK initialized successfully!" 或 "EaseMobSDK has already been initialized!"

*注：自动登录功能Android SDK 默认开启,iOS SDK默认关闭.

registerCallback //注册回调

uexEasemob.registerCallback()

说明

调用了改接口的页面都会受到回调，页面关闭时，请取消掉
请尽量少的在页面调用该接口，会影响效率
Root页面默认自动调用了此接口

unRegisterCallback //取消该页面的监听

uexEasemob.unRegisterCallback()

说明

取消该页面的监听

如果要取消所有页面的监听，请调用uexEasemob.unRegisterCallback(-1)

login(param,function(data){}) //登录

param为json字符串

var param = {
    username:,//用户名
    password:,//密码
};

data为json对象

var data = {
    result:,//1-成功,2-失败
    msg:,//提示信息
};

logout(function(data){}) //退出登录

data为json对象

var data = {
    result:,//1-登出成功,2-登出失败
    message:,//提示信息
};

registerUser(param,function(data){}) //注册

param为json字符串

var param = {
    username:,//用户名
    password:,//密码
};

data为json对象

var data = {
    result:,//1-成功,2-失败
    msg:,//提示信息
};

updateCurrentUserNickname(param) //更新当前用户的昵称

param为json字符串

var param = {    

    nickname:,
};

注:此方法主要为了在苹果推送时能够推送昵称(nickname)而不是userid,一般可以在登陆成功后从自己服务器获取到个人信息,然后拿到nick更新到环信服务器.并且,在个人信息中如果更改个人的昵称,也要把环信服务器更新下nickname 防止显示差异.

getLoginInfo(function(data){}) //获取当前登陆信息(仅iOS可用)

data为json对象

 var data ={

    userInfo://当前登陆用户信息
    isLoggedIn://当前是否已有登录用户  1-是 2-否
    isConnected://是否连上聊天服务器   1-是 2-否
    isAutoLoginEnabled://是否自动登录  1-是 2-否
};

onConnected(); //已连接上

onDisconnected(param) //链接断开

param为json字符串

var param = {
    error:,//1-账号被移除,2-账号其他设备登陆,3-连接不到聊天服务器,4-当前网络不可用 
};

2.2、Message

onNewMessage(param) //收到新消息监听

注:param为EMMessage的json格式对象
EMMessage具体结构见文末附录
所有离线和在线时接受到的的非透传消息,都通过此回调传递

onCmdMessageReceive(param) //透传消息监听

param为json字符串

var param = {
    msgId:,
    message:,//EMMessage 对象json格式
    action:,
};

onAckMessage(param) //消息已读监听

param为json字符串

var param = {
    msgId:,//消息ID
    username:,//来源
};

onDeliveryMessage(param) //消息送达监听

param为json字符串

var param = {
    msgId:,//消息ID
    username:,//来源
};

sendText(param) //发送文本消息及表情