消息体基类

自定义消息示例代码

import { JsonConverter, MessageContent, MessageFlag, MessageTag } from '@rongcloud/imlib';
import List from '@ohos.util.List';

const CustomOrderMessageObjectName = "App:OrderMsg";
const CustomOrderMessageFlag = MessageFlag.Count;


// 1. 继承 MessageContent 并实现 MessageTag 注解
&#64MessageTag(CustomOrderMessageObjectName,CustomOrderMessageFlag)
class CustomOrderMessage extends MessageContent {
  // 2. 按需增加属性
  id: string = ""; // 订单 ID
  name: string = ""; // 订单名称
  price: number = 0; // 订单价格

  // 3. 必须声明无参的构造方法，因为注册自定义消息时候，只能用无参构造方法
  constructor() {
    super();
  }

  // 4. 将消息对象转为 JSON 字符串
  encode(): string {
    // 4.1 将基类的数据保存到 map 中
    let map = super.encodeBaseData();

    // 4.2 将本类的独有属性放到 map 中
    // 说明：ts 的 map 必须指定 kv 的类型，所以存多种类型数据，需要转为 Object
    if (this.id) {
      map.set("id", this.id as Object);
    }
    if (this.name) {
      map.set("name", this.name as Object);
    }
    map.set("price", this.price as Object);

    // 4.3 将 map 转为 字符串
    return JsonConverter.stringifyFromHashMap(map);
  }

  // 5. 将字符串转为消息对象
  decode(contentJson: string): void {
    // 5.1 将字符串转为 map
    let map = JsonConverter.parseToHashMap(contentJson);
    // 5.2 将基类的数据解析出来
    super.decodeBaseData(map);

    // 5.3 将本类的独有属性解析
    // 说明：需要将 Object 转为对应的数据类型
    if (map.get("id")) {
      this.id = map.get("id") as string;
    }
    if (map.get("name")) {
      this.name = map.get("name") as string;
    }
    if (map.get("price")) {
      this.price = map.get("price") as number;
    }
  }

  // 6. 将当前类名返回：该方法的作用是防止代码混淆或者压缩后无法获取正常的类名
  // 直接写字符串可能会出现拼写错误的情况，所以此处建议直接使用 类名.name
  getClassName(): string {
    return CustomOrderMessage.name;
  }


  // 7. 返回搜索字段
  // 1) 不实现该方法，该类消息无法被搜索
  // 2) 实现该方法，返回 null 或者 List 长度为 0，无法被搜索
  // 3) 实现该方法， List 里面的 空字符串 和 null 会被忽略
  // 4) List 中必须包含有效的字符串才能被搜索到
  getSearchableWord(): List<string> | null {
   if (!this.name) {
     return null;
   }
   let list = new List<string>();
   list.add(this.name);
   return list;
  }
}

export { CustomOrderMessage, CustomOrderMessageObjectName }
Copy