Comment 评论

获取评论页数

// 返回评论页数，类型为int
var commentPage = Mudu.Room.Comment.GetPage()

发送评论

Mudu.Room.Comment.Send(
  // 要发送的评论文本，类型为string
  '活动很赞很给力',

  // 发送完成的回调函数，参数为response对象
  function (response) {
    response = JSON.parse(response)
    if (response.status === 'y') {
      console.log('发送成功')
    }
    if (response.status === 'n') {
      console.log('发送失败，错误码为：' + response.flag)
    }
  }
)

• response对象说明

{
  // 成功状态，类型为string，成功时为'y'，失败时为'n'
  status: 'y',

  // 状态码码，类型为int，成功时为0，失败不为0
  flag: 100,

  // 信息，类型为string，成功时为'发送消息成功！'，失败时为'发送消息失败！'
  info: "发送消息成功!/失败！"
}

• flag状态码码对照表

获取评论

Mudu.Room.Comment.Get(
  // 要获取评论的页码，类型为int
  2,

  // 评论获取成功的回调函数，参数为response对象
  function (response) {
    response = JSON.parse(response)
    if (response.status === 'y') {
      console.log('获取评论成功，数据为：', response.data)
    } 
    if (response.status === 'n'){
      console.log('获取评论失败')
    }
  }
)

• response返回结果说明

{
    // 状态
    "status": 'y',

    // 返回的数据
    "data": {
      // 还剩下多少页
      page: 70,

      // 获取到的评论
      comments: [
        {
          "id": 3438056,
          "visitor_id": "1493401897797743654_api",
          "username": "小白白",
          "message": "这个真不错",
          "avatar": "http://cdn12.mudu.tv/thumbnails/uploads/9/b5ed4ba472bbaa27e092be7594a2e31d.jpg",
          "dateline": 1493693178,
          "pushed": 1,
          "checked": 1,
          "top": 0,
          "msg_type": 10,
          "is_admin": 0
        },
        ......
      ]
    },
}

• comments说明

• msg_type 和 message之间的映射关系

若控制台中配置了聊天文字颜色或者是回复消息，SDK 使用方需要在收到消息后自行解析消息内容，参考此页底部的说明。

获取当前用户使用匿名身份聊天相关配置

var anonymousCommentConfig = Mudu.Room.Comment.GetAnonymousCommentConfig()

• anonymousCommentConfig 说明

设置用户匿名身份

说明：

1. 如果设置开启用户匿名身份成功，用户之后发送聊天时将会使用匿名身份发送；
2. 当次设置仅在本次sdk生命周期内有效，下次初始化sdk时需要重新设置聊天匿名身份；
3. 为避免与默认的“匿名观众”身份混淆，建议在对观众Assign实名身份之后再允许其使用匿名身份聊天

const param = {
  // 设置当前用户是否使用匿名身份聊天
  inUse: true,
  // 设置当前用户匿名身份的昵称，最大长度 60
  nickname: '匿名用户',
  // 设置当前用户匿名身份的头像
  avatar: 'https://static.mudu.tv/assets/anonymized-user-avatar.png'
}
Mudu.Room.Comment.SetAnonymousCommentConfig(
  // 要设置的匿名配置
  param,
  // 设置结果
  function (response) {
    response = JSON.parse(response)
    if (response.status === 'y') {
      console.log('设置用户匿名聊天身份成功')
    }
    if (response.status === 'n') {
      console.log('设置用户匿名聊天身份失败：', response)
    }
  }
)

• response 返回结果说明

{
  // 是否设置成功标志
  status: 'y',
  errcode: 1000
}

• errcode 说明

Comment.New事件

Comment.New事件会在评论新增的时候被触发

Mudu.MsgBus.On(
  // 事件名，值为Comment.New
  'Comment.New', 

  // 事件处理函数，参数为新的评论，类型为object
  function (newComment) {
    newComment = JSON.parse(newComment)
    console.log(newComment.username + '发送了一条新评论: ' + newComment.message)
  }
)

• 事件处理函数参数newComment对象说明

Comment.Top事件

Comment.Top事件会在评论被置顶或者取消置顶的时候被触发

Mudu.MsgBus.On(
  // 事件名，值为Comment.Top
  'Comment.Top',

  // 事件处理函数，参数为被置顶或取消置顶评论，类型为object
  function (topComment) {
    topComment = JSON.parse(topComment)
    console.log(topComment.top == 1 ? '被置顶的评论为' : '被取消置顶的评论为', topComment)
  }
)

Comment.Avaliable.Changed事件

Comment.Avaliable.Changed事件会在后台聊天设置 -> 允许观众聊天切换时被触发。

Mudu.MsgBus.On(
  // 事件名， 值为Comment.Avaliable.Changed
  'Comment.Avaliable.Changed',

  // 事件处理函数
  function (res) {
    res = JSON.parse(res)
    var msg = res.open == 0 ? '聊天已关闭' : '聊天已开启'
    console.log(msg)
  }
)

res 参数说明:

Visitor.Mute事件

Visitor.Mute事件会在某一个观众被禁言或者取消禁言的时候被触发

Mudu.MsgBus.On(
  // 事件名，值为Visitor.Mute
  'Visitor.Mute',

  // 事件处理函数，参数为禁言或者解禁的观众，类型为object
  function (user) {
    user = JSON.parse(user)
    var msg = user.mute == 1 ? '被禁言' : '被解除禁言'
    console.log(user.user + msg + ', 该观众的id为' + user.visitorId)
  }
)

user 参数说明：