用户管理
名称:member:kick
说明:将用户踢出房间
参数:
名称 | 描述 |
---|---|
xid | 欢拓给合作方用户分配的唯一性ID |
示例:
MT.emit('member:kick',xid,function(res){
if(res.code === MT.CODE.SUCCESS){
//提示成功
}else{
//提示失败
}
});
名称:member:join:me
说明:用户进入房间,自己会收到的消息
参数说明:
@member:
字段 | 描述 |
---|---|
xid | 欢拓用户ID |
uid | 合作方用户ID |
nickname | 用户ID |
role | 角色 |
voice | 语音属性 |
@voiceQueue:
字段 | 描述 |
---|---|
action | 目前麦序运行状态 |
memberState | 当前麦序开放状态 |
data | 麦序列表 |
voicePower | 当前可以说话的用户ID列表 |
示例:
MT.on('member:join:me',function(res){
if(res.code === MT.CODE.SUCCESS){
//res.member;
//res.online;
//res.voiceQueue;
}else{
//进入房间失败
}
});
示例:
MT.on('member:join:me',function(res){
console.log('你已加入房间');
});
名称:member:join:other
说明:他人进入房间,用户会收到的消息
参数说明:
member 同上
示例:
MT.on('member:join:other',function(res){
console.log(res.member.nickname +'进入房间');
});
名称:member:total
@说明:在线人数
@参数说明:
@Number: total 返回当前在线人数
示例:
MT.on('member:total', function(total){
$('#online_total').text(total);
});
名称:member:leave
说明:用户离开房间
参数说明:
字段 | 描述 |
---|---|
xid | 欢拓用户ID |
uid | 合作方用户ID |
nickname | 用户昵称 |
total | 当前房间人数 |
示例:
MT.on('member:leave',function(res){
console.log(res.nickname + ' 离开了') ;
});
名称:member:forceout
说明:用户被强制离开房间,有相同的账号进入
参数说明:
字段 | 描述 |
---|---|
xid | 欢拓平台用户ID |
uid | 合作方用户ID |
nickname | 用户昵称 |
示例:
MT.on('member:forceout',function(res){
console.log(res.nickname + '已经在其他地方登录了');
//window.location.href = 'http://www.sunlands.com';
});
名称:member:list
说明:用户列表
参数说明:
返回格式:array
字段 | 类型 | 描述 |
---|---|---|
xid | string | 用户唯一ID |
uid | string | 合作方用户唯一ID |
nickname | string | 昵称 |
gender | int | 性别 |
avatar | string | 头像地址 |
chat | object | 聊天属性,enable属性为当前用户发言状态 0禁言,1未禁言 |
示例:
MT.on('member:list',function(res){
// 返回用户列表
});
名称:member:kick
说明:用户被踢出房间
参数说明:
字段 | 描述 |
---|---|
nickname | 昵称 |
xid | 欢拓用户uid |
uid | 合作方用户uid |
示例:
MT.on('member:kick',function(res){
window.location.href = '';
});
名称:member:forbidden
说明:用户被禁止进入房间