聊天模块

chat:send 发送聊天

说明:发送文本信息

示例:
MT.emit('chat:send',{type:"matchKey", msg:"你好吗?"},function(res){
    if(res.code === MT.CODE.SUCCESS){
        //发送成功,将消息插入本地
        if(res)
    }else{
    //发送失败,提示 ret.msg
    }
});

chat:disable:all 禁止聊天

说明:禁止用户聊天,用户当前的聊天状态是否为禁止在chat:send广播放回的数据中会携带chat对象,其中enable就是用户当前的状态。取值有 0 || 1 => 禁言 || 未禁言;另,刷新之后返回的用户列表也会返回用户聊天的最新状态

参数说明:

字段 描述
status 是否开启全体禁言 1 => 开启; 0 => 关闭
示例:
MT.emit('chat:disable:all', status ,function(res){
    if(res.code === MT.CODE.SUCCESS){
        // 禁言成功
    }else{
        // 禁言失败
    }
});

chat:disable 禁止聊天

说明:禁止用户聊天,用户当前的聊天状态是否为禁止在chat:send广播放回的数据中会携带chat对象,其中enable就是用户当前的状态。取值有 0 || 1 => 禁言 || 未禁言;另,刷新之后返回的用户列表也会返回用户聊天的最新状态

参数说明:

字段 描述
xid 禁言用户xid
示例:
MT.emit('chat:disable', xid ,function(res){
    if(res.code === MT.CODE.SUCCESS){
        // 禁言成功
    }else{
        // 禁言失败
    }
});

chat:enable 聊天解禁

说明:用户聊天解禁,用户当前的聊天状态是否为禁止在chat:send广播放回的数据中会携带chat对象,其中enable就是用户当前的状态。取值有 0 || 1 => 禁言 || 未禁言;另,刷新之后返回的用户列表也会返回用户聊天的最新状态

参数说明:

字段 描述
xid 解禁用户xid
示例:
MT.emit('chat:enable', xid ,function(res){
    if(res.code === MT.CODE.SUCCESS){
        // 解禁成功
    }else{
        // 解禁失败
    }
});

chat:list 历史聊天(返回50条)

说明:文字聊天历史数据

字段 描述
chatList 聊天数据列表(Array)
示例:
HT.on('chat:list',function(chatList){
    chatList.forEach(chat => {
        // todo...
    })
});    

chat:disable:all 全体禁言

说明:全体禁言

字段 描述
code 0 => 关闭 1=> 开启 (Number)
示例:
HT.on('chat:disable:all',function(code){
    // code
});    

chat:disable 禁言

说明:禁言

字段 描述
args 被禁言用户的xid和nickname
示例:
HT.on('chat:disable',function(args){
    // args
});    

chat:enable 解禁

说明:解禁

字段 描述
args 解禁用户的xid和nickname
示例:
HT.on('chat:enable',function(args){
    // args
});    

chat:screen:clear 发送清屏

说明:文字聊天区域全局清屏

示例:
MT.emit('chat:screen:clear',function(res){
    if(res.code === MT.CODE.SUCCESS){
    }
});        

chat:del 删除聊天(v5.5+)

返回参数:

字段 描述
xid 欢拓用户ID
time 聊天发起时间戳
示例:
  HTSDK.on('chat:del', function(res){
     // delete chat '#chat_{res.time}_{res.xid}'
  });

chat:reply 回复聊天(v5.5+)

返回参数:

字段 描述
xid 欢拓用户ID
at 被回复用户数组 (二维数组[[xid, nick, ...])
uid 合作方用户ID
nickname 昵称
role 角色
msg 消息内容(String)
quoteMsg 引用消息(String)
type 消息类型(String)
time 时间
avatar 头像
chat 包含enable属性,1表示该用户可以发言,0表示该用户被禁止发言
示例:
  HTSDK.on('chat:reply', function(res){
     // reply chat res 
  });

chat:send 聊天信息

说明:接收文本信息

参数说明:

字段 描述
xid 欢拓用户ID
uid 合作方用户ID
nickname 昵称
role 角色
msg 消息内容(String)
type 消息类型(String)
time 时间
avatar 头像
chat 包含enable属性,1表示该用户可以发言,0表示该用户被禁止发言
示例:
  MT.on('chat:send',function(res){
     console.log(res.time + '  ' + res.nickname + ':' + res.msg)
  });

chat:screen:clear 清屏

示例:
MT.on('chat:screen:clear',function(){
     //清空文字聊天区域
});

SDK.chat.delete() 删除聊天(v5.5+)

说明:删除指定聊天信息

调用参数说明:

字段 描述
xid 欢拓用户xid
time 时间戳time
callback 回调函数

返回值:

字段 描述
code 0 => 成功 其他为失败代码 (Number)
msg 返回消息 (String)
调用示例:
// 对应监听事件:chat:delete
  SDK.chat.delete({
      xid: chat.xid,
      time: chat.time,
      callback: function (res) {
          // console.log('chat.delete message ==>', res)
      }
  });

SDK.chat.reply() 回复聊天(v5.5+)

说明:回复指定聊天

调用参数说明:

字段 描述
quoteMsg 引用消息
at 回复某人消息 [[xid, nickname], [xid, nickname] ...] 二维数组
msg 发送消息
callback 回调函数

返回值:

字段 描述
code 0 => 成功 其他为失败代码 (Number)
msg 返回消息 (String)
调用示例:
// 对应监听事件:chat:reply
  SDK.chat.reply({
      quoteMsg: '引用的消息',
      msg: '回复的消息',
      at: [[123, 'testUser']]
      callback: function (res) {
          // console.log('chat.reply message ==>', res)
      }
  }); 
Copyright Talkfun all right reserved,powered by Gitbook修订时间: 2021-05-11 11:19:29

results matching ""

    No results matching ""