Interface SystemMessageInterface

示例

nim.deleteAllLocalSysMsgs({
  done: function(err) {
    if (err) {
      console.log('删除所有本地系统通知失败', err)
    } else {
      console.log('删除所有本地系统通知成功')
    }
  }
})

示例场景

• 本地系统通知数量管理

示例

// 删除单条
nim.deleteLocalSysMsg({
  idServer: '123456',
  done: function(err) {
    if (err) {
      console.log('删除本地系统通知失败', err)
    } else {
      console.log('删除本地系统通知成功')
    }
  }
})

// 删除多条
nim.deleteLocalSysMsg({
  idServer: ['123456', '789012'],
  done: function(err) {
    if (err) {
      console.log('批量删除本地系统通知失败', err)
    } else {
      console.log('批量删除本地系统通知成功')
    }
  }
})

示例场景

• 本地系统通知数量管理

示例

nim.getLocalSysMsgs({
  type: 'teamInvite',
  read: false,
  limit: 20,
  done: function(err, sysMsgs) {
    if (err) {
      console.log('获取本地系统通知失败', err)
    } else {
      console.log('获取本地系统通知成功', sysMsgs)
    }
  }
})

标记后会触发 onupdatesysmsgunread 回调

示例

nim.markSysMsgRead({
  sysMsgs: [sysMsg1, sysMsg2],
  done: function(err) {
    if (err) {
      console.log('标记系统消息已读失败', err)
    } else {
      console.log('标记系统消息已读成功')
    }
  }
})

注，自定义系统通知(sendCustoSysmMsg)和自定义消息(sendCustomMsg)的区别如下：

1. 自定义消息属于 NIMMessage, 会存储在云信服务器消息数据库中, 与其他消息一同传递给开发者，可以查询历史消息，。
2. 自定义系统通知属于 NIMSystemMessage, 用于第三方通知端侧, 不会存储在云信服务器数据库中，无法查询历史消息。SDK 仅仅负责传递这些通知。

示例场景

• p2p正在输入提示

示例

// 发送"正在输入"提示
nim.sendCustomSysMsg({
  scene: 'p2p',
  to: 'user1',
  content: JSON.stringify({ type: 'typing' }),
  sendToOnlineUsersOnly: true,
  isPushable: false,
  done: function(err, sysMsg) {
    if (err) {
      console.log('发送自定义系统通知失败', err)
    } else {
      console.log('发送自定义系统通知成功', sysMsg)
    }
  }
})

示例

nim.updateLocalSysMsg({
  idServer: '123456',
  state: 'passed',
  localCustom: JSON.stringify({ handled: true }),
  done: function(err, sysMsg) {
    if (err) {
      console.log('更新本地系统通知失败', err)
    } else {
      console.log('更新本地系统通知成功', sysMsg)
    }
  }
})