ImSdk 接口文档 (version 1.1.1)

环境配制

1.引入文件

1.1.script标签引入

    <script type="text/javascript" src="{sdk}/zby_im_sdk.js"></script>

1.2.npm+import引入

    // 安装
    npm i -D zby_im_sdk

    // 引入
    import ImSdk from "zby_im_sdk";

1.3.requirejs引入

    require(["{sdk}/zby_im_sdk.js"], function (ImSdk) {});

1.4.使用

    // 创建ImSdk对象
    let im = new ImSdk(options);

    // 绑定监听事件
    im.on("handlerConnected", function () {});

    // 初始化SDK
    im.initIm();

注：

（1） 客户端发送的authenticate事件 和客户端接收的事件unauthorized和authenticated事件与原来保持一致；

（2） 每个命名空间的join_room、leave_room、disconnect一致，只在control中列出；

（3） 所有字段必须填充，不需要该字段可以置为空；

（4） 输入、输出字段名整理为一致，所以客户端emit事件的参数名大都做了调整

（5） 带删除线的是去掉的字段

（6） 字段名全部为小写

（7） 除authenticate 事件外，emit都带Callback回调，回调的参数定义为：

"ack_status": {
    OK: {
        code: 0,
        message: "OK"
    },

    INTERNAL_ERROR: {
        code: 401,
        message: "服务器内部错误"
    },

    PERMISSION_DENY: {
        code: 201,
        message: "用户无权限"
    },

    PARAMETER_ERROR: {
        code: 201,
        message: "参数错误"
    }

    FAILED: {
        code: 400,
        message: "请求失败"
    }
}

2.1 control（on/emit事件）

2.2 chat（on/emit事件）

2.3 interact（on/emit事件）