addChatRoomEntry method

Future<int> addChatRoomEntry(
  1. String targetId,
  2. String key,
  3. String value,
  4. bool deleteWhenLeft,
  5. bool overwrite, {
  6. IRCIMIWAddChatRoomEntryCallback? callback,
})

设置聊天室自定义属性。

  • targetId 聊天室会话 ID
  • key 聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符
  • value 聊天室属性对应的值，最大长度 4096 个字符
  • deleteWhenLeft 用户掉线或退出时，是否自动删除该 Key、Value 值
  • overwrite 如果当前 key 存在，是否进行覆盖
  • callback 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。
  • 返回值 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码
  • 接口回调 onChatRoomEntryAdded

Implementation

Future<int> addChatRoomEntry(String targetId, String key, String value,
    bool deleteWhenLeft, bool overwrite,
    {IRCIMIWAddChatRoomEntryCallback? callback}) async {
  return RCIMWrapperPlatform.instance.addChatRoomEntry(
      targetId, key, value, deleteWhenLeft, overwrite,
      callback: callback);
}