鸿蒙 IMLib-v26.6.0
    Preparing search index...

    Class StreamMessage

    流式消息内容。

    接收到 objectName 为 RC:StreamMsg 的消息时，需要通过 IMEngine.getInstance().requestStreamMessage(...) 主动拉取增量内容； 增量事件通过 StreamMessageRequestEventListener 推送。

    26.4.0

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    extra? userInfo? mentionedInfo? rawString? destructDuration? content type isComplete completeReason stopReason isSync

    Methods

    encodeBaseData decodeBaseData encode decode getClassName getSearchableWord

    Constructors

    Properties

    extra?: string

    消息的附加信息，会随着消息发送出去

    Message.extra

    userInfo?: UserInfo

    消息携带的用户信息

    mentionedInfo?: MentionedInfo

    消息的 @ 信息

    rawString?: string

    消息的原始内容

    SDK 执行消息的 decode 方法正常时，会将数据解析到消息的各个字段，rawString 将会为空

    如果 decode 方法异常时会将消息的原始数据保存在 rawString 中

    destructDuration?: number

    阅后即焚时长，单位秒

    destructDuration <= 0 代表是普通消息
    destructDuration > 0 代表是阅后即焚消息，该消息已读后，经过 destructDuration 时间后销毁

    1.3.0

    content

    content: string = ''

    当前累加到此刻的完整文本内容。

    type: string = ''

    内容类型标记（服务端定义，透传给业务）。

    isComplete: boolean = false

    服务端是否标记流完成。

    completeReason: number = 0

    完成原因（服务端定义，0 表示正常）。

    stopReason: number = 0

    停止原因（服务端定义）。

    isSync: boolean = false

    本地是否已完整同步。 仅 isSync=true 时再次 requestStreamMessage 会被 SDK 用 StreamMessageSynced(39007) 拒绝。

    Methods

    • 将基类的基础数据保存到 map 中

      Returns HashMap<string, Object>

    • 将基类的基础数据从 map 中解析出来

      Parameters

      • map: HashMap<string, Object>

      Returns void

    • 编码方法，将消息对象转为 string

      Returns string

    • 解码方法，将 string 数据解析到消息的各个字段

      Parameters

      • contentString: string

      Returns void

    • 返回消息体类名。直接写字符串可能会出现拼写错误的情况，所以此处建议直接使用 类名.name

      该方法的作用是保证代码处于混淆的状态依旧可以获取正常的类名
      类名通过 .name 属性访问，通常不会受到代码混淆或压缩的影响，因为这个属性是在编译阶段就确定的，是对 TypeScript 类型系统的一种反射
      对象.constructor.name 在没有代码混淆或压缩的情况下，它通常会返回构造函数的原始名称。然而，在代码混淆或压缩后，构造函数名可能会被改变或简化，这取决于混淆或压缩器的实现
      如果此方法返回的不是对应的类名，将不会正常执行对应消息类的 encode() 方法

      Returns string

      该消息体类名

    • 返回消息体内的可搜索内容

      如果消息包含多个字段,可将每个字段填充到 List 中; 比如图文消息的 title 和 summary。

      SDK 内置消息已支持搜索，自定义消息需要实现该方法
      1) 不实现该方法，该类消息无法被搜索
      2) 实现该方法，返回 null 或者 List 长度为 0，无法被搜索
      3) 实现该方法， List 里面的 空字符串 和 null 会被忽略
      4) List 中必须包含有效的字符串才能被搜索到

      Returns any

      可搜索的内容

      1.1.0

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods