目录

基础功能

事件监听

WebIM.conn.listen({
 onOpened: function ( message ) {          //连接成功回调
        // 使用2.0SDK需注意以下内容 (3.0+中已废弃)
        // 如果isAutoLogin设置为false,那么必须手动设置上线,否则无法收消息
        // 手动上线指的是调用conn.setPresence(); 如果conn初始化时已将isAutoLogin设置为true
        // 则无需调用conn.setPresence();
    },
    onClosed: function ( message ) {},         //连接关闭回调
    onTextMessage: function ( message ) {},    //收到文本消息
    onEmojiMessage: function ( message ) {},   //收到表情消息
    onPictureMessage: function ( message ) {}, //收到图片消息
    onRoster: function ( message ) {},         //处理好友申请
    onInviteMessage: function ( message ) {},  //处理群组邀请
    onOnline: function () {},                  //本机网络连接成功
    onOffline: function () {},                 //本机网络掉线
    onError: function ( message ) {},          //失败回调
    onRecallMessage: function (message) {},    //收到撤回消息的回调
    onReceivedMessage: function(message){},    //收到消息送达服务器回执
    onDeliveredMessage: function(message){},   //收到消息送达客户端回执
    onReadMessage: function(message){},        //收到消息已读回执
  // ......
})

注册

根据用户名/密码/昵称注册环信 IM

let options = {
     username: 'username',
     password: 'password',
    nickname: 'nickname',
    appKey: WebIM.config.appkey,
    success: function () { },  
    error: function () { }, 
    apiUrl: WebIM.config.apiURL
};
WebIM.conn.registerUser(options);

登录

用户名/密码登录

let options = { 
  apiUrl: WebIM.config.apiURL,
  user: 'username',
  pwd: 'password',
  appKey: WebIM.config.appkey
};
WebIM.conn.open(options);

使用 Token 登录

let options = {
    apiUrl: WebIM.config.apiURL,
    user: 'username',
    accessToken: 'token',
    appKey: WebIM.config.appkey
};
WebIM.conn.open(options);

发送消息

let id = WebIM.conn.getUniqueId();
let msg = new WebIM.message(msgType, id);
msg.set({
    msg: 'userMessage',
    from: 'username',
    to: 'username',
    roomType: false,
    chatType: chatType,
    success(id, serverMsgId){}
});
WebIM.conn.send(msg.body);

退出

WebIM.conn.close();