这是本文档旧的修订版!
初始化
创建连接
var conn = {};
WebIM.config = config;
conn = WebIM.conn = new WebIM.connection({
isHttpDNS: WebIM.config.isHttpDNS,
isMultiLoginSessions: WebIM.config.isMultiLoginSessions,
https: WebIM.config.https,
url: WebIM.config.xmppURL,
isAutoLogin: false,
heartBeatWait: WebIM.config.heartBeatWait,
autoReconnectNumMax: WebIM.config.autoReconnectNumMax,
autoReconnectInterval: WebIM.config.autoReconnectInterval,
isStropheLog: WebIM.config.isStropheLog,
delivery: WebIM.config.delivery
})
// WebIM.config 为之前集成里介绍的WebIMConfig.js
添加回调函数
conn.listen({
onOpened: function ( message ) { //连接成功回调
// 如果isAutoLogin设置为false,那么必须手动设置上线,否则无法收消息
// 手动上线指的是调用conn.setPresence(); 如果conn初始化时已将isAutoLogin设置为true
// 则无需调用conn.setPresence();
},
onClosed: function ( message ) {}, //连接关闭回调
onTextMessage: function ( message ) {}, //收到文本消息
onEmojiMessage: function ( message ) {}, //收到表情消息
onPictureMessage: function ( message ) {}, //收到图片消息
onCmdMessage: function ( message ) {}, //收到命令消息
onAudioMessage: function ( message ) {}, //收到音频消息
onLocationMessage: function ( message ) {},//收到位置消息
onFileMessage: function ( message ) {}, //收到文件消息
onVideoMessage: function (message) {
var node = document.getElementById('privateVideo');
var option = {
url: message.url,
headers: {
'Accept': 'audio/mp4'
},
onFileDownloadComplete: function (response) {
var objectURL = WebIM.utils.parseDownloadResponse.call(conn, response);
node.src = objectURL;
},
onFileDownloadError: function () {
console.log('File down load error.')
}
};
WebIM.utils.download.call(conn, option);
}, //收到视频消息
onPresence: function ( message ) {}, //处理“广播”或“发布-订阅”消息,如联系人订阅请求、处理群组、聊天室被踢解散等消息
onRoster: function ( message ) {}, //处理好友申请
onInviteMessage: function ( message ) {}, //处理群组邀请
onOnline: function () {}, //本机网络连接成功
onOffline: function () {}, //本机网络掉线
onError: function ( message ) {}, //失败回调
onBlacklistUpdate: function (list) { //黑名单变动
// 查询黑名单,将好友拉黑,将好友从黑名单移除都会回调这个函数,list则是黑名单现有的所有好友信息
console.log(list);
},
onReceivedMessage: function(message){}, //收到消息送达服务器回执
onDeliveredMessage: function(message){}, //收到消息送达客户端回执
onReadMessage: function(message){}, //收到消息已读回执
onCreateGroup: function(message){}, //创建群组成功回执(需调用createGroupNew)
onMutedMessage: function(message){} //如果用户在A群组被禁言,在A群发消息会走这个回调并且消息不会传递给群其它成员
});
注册
根据用户名/密码/昵称注册环信 Web IM :
var options = {
username: 'username',
password: 'password',
nickname: 'nickname',
appKey: WebIM.config.appkey,
success: function () { },
error: function () { },
apiUrl: WebIM.config.apiURL
};
conn.registerUser(options);
登录
用户名/密码登录
使用用户名/密码登录环信 Web IM :
var options = {
apiUrl: WebIM.config.apiURL,
user: 'username',
pwd: 'password',
appKey: WebIM.config.appkey
};
conn.open(options);
使用 Token 登录
1. 使用用户名/密码登录,获取并存储 Token 。本例演示将 Token 存入 cookie 。
var options = {
apiUrl: WebIM.config.apiURL,
user: 'username',
pwd: 'password',
appKey: WebIM.config.appkey,
success: function (token) {
var token = token.access_token;
WebIM.utils.setCookie('webim_' + encryptUsername, token, 1);
},
error: function(){
}
};
conn.open(options);
2. 使用 Token 登录环信 Web IM。
var options = {
apiUrl: WebIM.config.apiURL,
user: 'username',
accessToken: 'token',
appKey: WebIM.config.appkey
};
conn.open(options);
退出
conn.close();
常见问题
Q: 是否支持 token 登录,是否支持 HTTPS?
A: 支持。
Q: 是否支持重连?
A: 支持,当连接不能建立时会尝试重新连接,连接次数可在config里配置。
Q: ws有上行没有下行?
A: 可能是浏览器缓存了错误的ws返回结果,解决办法是加个时间戳参数,强制浏览器不走缓存。
Q: 收到提示“您的连接不是私密连接”,怎么处理?
A: chrome53屏蔽了赛门铁克的某些日期颁发的证书,升级chrome就可以解决。详细信息可查看:http://www.jkeabc.com/376605.html 或者 https://sslmate.com/blog/post/ct_redaction_in_chrome_53。
上一页: Web IM 集成方式
下一页: Web SDK API Doc