easeimSDK

论坛示例

为帮助用户更好更快的使用插件,论坛维护了一个示例(插件demo论坛帖链接),示例中包含示例代码、知识点讲解、注意事项等,供您参考。

插件demo论坛帖示例:https://developer.yonyou.com/forum.php?mod=viewthread&tid=205814

概述

环信IM插件概述

本插件封装环信开放平台的原生 IM SDK,集成了环信的IM功能,实现IM通信的功能。 本插件最低支持iOS11,编译时应用打包界面高级设置里,注意选择iOS固件版本。

插件使用攻略

使用之前须从环信开放平台申请开发者账号并创建应用,获取 appid。 环信接入流程参考环信平台接入文档

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

  • 名称:huanxin
  • 参数:EASEMOB_APPKEY、com.baidu.lbsapi.API_KEY、com.vivo.push.api_key、com.vivo.push.app_id
  • 配置示例:


 <feature name="huanxin">
    <param name="EASEMOB_APPKEY" value="1147170910178242#achuanxin"/>
    <param name="com.baidu.lbsapi.API_KEY" value="3ecea51f560650b1ed8a4b99808f52e8"/>
    <param name="com.vivo.push.api_key" value="9b74dbfc-55c4-4441-9d0a-561ff21addc7"/>
    <param name="com.vivo.push.app_id" value="11025"/>
  </feature>
  
 
  • 字段描述:

    ** EASEMOB_APPKEY: (必须配置)从环信开放平台获取的 appid。appid 申请方法参考环信平台接入文档。 ** com.baidu.lbsapi.API_KEY:(必须配置)从环信开放平台获取的 com.baidu.lbsapi.API_KEY。appid 申请方法参考环信平台接入文档。 ** com.vivo.push.api_key:(必须配置)从环信开放平台获取的 com.vivo.push.api_key。appid 申请方法参考环信平台接入文档。 ** com.vivo.push.app_id:(必须配置)从环信开放平台获取的 com.vivo.push.app_id。appid 申请方法参考环信平台接入文档

插件接口

registerhuanxin

注册IM账号

registerhuanxin(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    username:""     // 字符串类型,注册的用户名
        pwd:""     //字符串类型,注册的用户名密码

}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //1(失败),
                //0(成功)
}

示例代码

 function register() {
        var demo = api.require('easeimSDK');
        demo.registerhuanxin({
            username:'qwe1234',
            pwd:'111111',
        },function(ret, err){
            // code 0  成功  1失败
            // msg  错误信息
              alert('返回值:'+JSON.stringify(ret));
        });
    }

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

** loginhuanxin**

登录IM账号

loginhuanxin(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    username:""     // 字符串类型,注册的用户名
        pwd:""     //字符串类型,注册的用户名密码

}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //1(失败),
                //0(成功)
                            // msg  错误信息

}

示例代码

 function register() {
        var demo = api.require('easeimSDK');
        demo.loginhuanxin({
            username:'qwe1234',
            pwd:'111111',
        },function(ret, err){
            // code 0  成功  1失败
            // msg  错误信息
              alert('返回值:'+JSON.stringify(ret));
        });
    }

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

** loginout**

退出登录 loginout(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //1(失败),
                //0(成功)
                            // msg  错误信息

}

示例代码

 function loginout() {
        var demo = api.require('easeimSDK');
        demo.loginout({
        },function(ret, err){

            // code 0  成功  1失败
            // msg  错误信息
            alert('返回值:'+JSON.stringify(ret));
        });
    }

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

** replylist**

跳转会话页面

replylist(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //1(失败),
                //0(成功)
                            // msg  错误信息

}

示例代码

 function loginout() {
        var demo = api.require('easeimSDK');
        demo.replylist({
        },function(ret, err){

            // code 0  成功  1失败
            // msg  错误信息
            alert('返回值:'+JSON.stringify(ret));
        });
    }

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

** maillist**

跳转通讯录页面

maillist(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //1(失败),
                //0(成功)
                            // msg  错误信息

}

示例代码

 function loginout() {
        var demo = api.require('easeimSDK');
        demo.maillist({
        },function(ret, err){

            // code 0  成功  1失败
            // msg  错误信息
            alert('返回值:'+JSON.stringify(ret));
        });
    }

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

** openBlacklist**

打开黑名单页面

openBlacklist(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{

}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //1(失败),
                //0(成功)
                            // msg  错误信息

}

示例代码

 function loginout() {
        var demo = api.require('easeimSDK');
        demo.openBlacklist({
        },function(ret, err){

            // code 0  成功  1失败
            // msg  错误信息
            alert('返回值:'+JSON.stringify(ret));
        });
    }

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/04/8