RongIMLib View Markdown
    Preparing search index...

    Function updateExpansionForUltraGroupMessage

    • 设置、更新消息扩展信息

      Parameters

      • expansion: { [key: string]: string }

        消息扩展信息,类型是 Object。Key 支持大小写英文字母、数字、特殊字符 + = - _ 的组合方式,不支持汉字。最大 32 个字符。
        (SDK < 5.3.0)Value 最大 64 个字符
        (SDK ≧ 5.3.0)Value 最大 4096 个字符

      • message: IAReceivedMessage

        接收到的消息,类型是 IAReceivedMessage

      Returns Promise<RCResult<void>>

      设置、更新消息扩展信息,用于超级群消息扩展信息的设置、更新,消息扩展信息 适用场景:原始消息增加状态标识的需求,都可使用消息扩展

      1. 消息评论需求,可通过设置原始消息扩展信息的方式添加评论信息。
      2. 礼物领取、订单状态变化需求,通过此功能改变消息显示状态。例如:向用户发送礼物,默认为未领取状态,用户点击后可设置消息扩展为已领取状态
      • 注意:
      1. 每次设置消息扩展将会产生内置通知消息,频繁设置扩展会产生大量消息
      2. 仅当发送消息时指定 canIncludeExpansion 值为 true,才可对消息进行扩展

      5.2.0 仅 Web 端 IMLib 支持超级群。

      const expansion = { key1: 'value1' };
      const message = {} // 需要设置的消息,类型为 IAReceivedMessage
      const res = await RongIMLib.updateExpansionForUltraGroupMessage(expansion, message);
      console.log('设置、更新消息扩展信息结果:', res);