Class MsgStore

constructor

• new MsgStore(rootStore, nim, localOptions): MsgStore

• Parameters

  • rootStore: RootStore

  • nim: NIM

  • localOptions: LocalOptions

  Returns MsgStore

collectionMsgs

logger

msgs

pinMsgs

replyMsgs

addCollectionActive

• addCollectionActive(params): Promise<void>

• 添加一个收藏

  Parameters

  • params: V2NIMAddCollectionParams

    添加收藏的相关参数

  Returns Promise<void>

addMsg

• addMsg(conversationId, msgs): void

• 往内存中添加消息

  Parameters

  • conversationId: string

    消息所属的会话的ID

  • msgs: V2NIMMessageForUI[]

  Returns void

cancelMessageAttachmentUploadActive

• cancelMessageAttachmentUploadActive(msg): Promise<void>

• 取消上传

  Parameters

  • msg: V2NIMMessage

    消息对象

  Returns Promise<void>

deleteMsgActive

• deleteMsgActive(msgs): Promise<void>

• 单向删除消息

  Parameters

  • msgs: V2NIMMessage[]

    消息对象数组

  Returns Promise<void>

deletePinInfoByMessageClientId

• deletePinInfoByMessageClientId(conversationId, messageClientIds): void

• Parameters

  • conversationId: string

  • messageClientIds: string[]

  Returns void

destroy

• destroy(): void

• 销毁MsgStore，会取消消息相关事件监听

  Returns void

forwardMsgActive

• forwardMsgActive(msg, conversationId, comment?): Promise<void>

• 转发消息

  Parameters

  • msg: V2NIMMessageForUI

    消息对象

  • conversationId: string

    会话id

  • Optional comment: string

    评论

  Returns Promise<void>

getCollectionListByOptionActive

• getCollectionListByOptionActive(option): Promise<V2NIMCollection[]>

• 获取收藏列表

  Parameters

  • option: V2NIMCollectionOption

    查询参数

  Returns Promise<V2NIMCollection[]>

getHistoryMsgActive

• getHistoryMsgActive(options): Promise<V2NIMMessage[]>

• 获取历史消息

  Parameters

  • options: {
        conversationId: string;
        endTime: number;
        lastMsgId?: string;
        limit: number;
    }

    • conversationId: string

      消息所属的会话的ID

    • endTime: number

      结束时间戳, 精确到 ms, 默认为服务器的当前时间

    • Optional lastMsgId?: string

      上次查询的最后一条消息的 messageServerId, 第一次不填

    • limit: number

      本次查询的消息数量限制, 最多 100 条, 默认 100 条

  Returns Promise<V2NIMMessage[]>

getMsg

• getMsg(conversationId?, idClients?): V2NIMMessageForUI[]

• 从内存中获取消息

  Parameters

  • Optional conversationId: string

    消息所属的会话的ID

  • Optional idClients: string[]

    端测生成的消息id数组

  Returns V2NIMMessageForUI[]

getPinnedMessageListActive

• getPinnedMessageListActive(conversationId): Promise<PinInfos>

• 获取 pin 消息列表

  Parameters

  • conversationId: string

    会话id

  Returns Promise<PinInfos>

getReplyMsgActive

• getReplyMsgActive(conversationId): void | V2NIMMessage

• 获取回复消息

  Parameters

  • conversationId: string

  Returns void | V2NIMMessage

getTeamMessageReceiptDetailsActive

• getTeamMessageReceiptDetailsActive(message, memberAccountIds?): Promise<V2NIMTeamMessageReadReceiptDetail>

• 获取群消息已读未读详情

  Parameters

  • message: V2NIMMessage

    消息

  • Optional memberAccountIds: string[]

  Returns Promise<V2NIMTeamMessageReadReceiptDetail>

getTeamMsgReadsActive

• getTeamMsgReadsActive(msgs, conversationId): Promise<void>

• 获取群组消息已读未读数

  Parameters

  • msgs: V2NIMMessage[]

    消息数组

  • conversationId: string

    会话id

  Returns Promise<void>

handleMsgForSDK

• handleMsgForSDK(msg): V2NIMMessage

• Parameters

  • msg: V2NIMMessageForUI

  Returns V2NIMMessage

handleMsgPinState

• handleMsgPinState(msg, curPinMsgsMap): V2NIMMessageForUI

• 处理消息的 pinState

  Parameters

  • msg: V2NIMMessageForUI

  • curPinMsgsMap: Map<string, PinInfo>

  Returns V2NIMMessageForUI

handleReceiveAIMsg

• handleReceiveAIMsg(msg): V2NIMMessageForUI

• Parameters

  • msg: V2NIMMessageForUI

  Returns V2NIMMessageForUI

pinMessageActive

• pinMessageActive(message, serverExtension?): Promise<void>

• pin 一条消息

  Parameters

  • message: V2NIMMessage

    需要被 pin 的消息体

  • Optional serverExtension: string

    扩展字段

  Returns Promise<void>

reCallMsgActive

• reCallMsgActive(msg): Promise<void>

• 撤回消息

  Parameters

  • msg: V2NIMMessage

    消息对象

  Returns Promise<void>

regenAIMessageActive

• regenAIMessageActive(message, params): Promise<void>

• 重新生成 ai 消息

  注: 若是流式消息, 必须等到流式分片输出完毕, 才允许调用此 API

  此外他支持两种配置

  1. 更新，新消息覆盖老消息---只允许更新3天内的消息
  2. 新消息，产生一条新消息

  Parameters

  • message: V2NIMMessage

    需要重新输出的原始数字人消息

  • params: V2NIMMessageAIRegenParams

    确定重新输出的操作类型

  Returns Promise<void>

removeCollectionsActive

• removeCollectionsActive(collections): Promise<void>

• 移除相关收藏

  Parameters

  • collections: V2NIMCollection[]

    需要移除的相关收藏

  Returns Promise<void>

removeMsg

• removeMsg(conversationId?, idClients?): void

• 从内存中删除消息

  Parameters

  • Optional conversationId: string

    消息所属的会话的ID

  • Optional idClients: string[]

    端测生成的消息id数组

  Returns void

removeReplyMsgActive

• removeReplyMsgActive(conversationId): void

• 回复消息

  Parameters

  • conversationId: string

  Returns void

replyMessageByThreadActive

• replyMessageByThreadActive(message, repliedMessage, conversationId, params?): Promise<void>

• 回复消息

  Parameters

  • message: V2NIMMessage

  • repliedMessage: V2NIMMessage

  • conversationId: string

    会话id

  • Optional params: V2NIMSendMessageParams

  Returns Promise<void>

replyMsgActive

• replyMsgActive(msg): void

• 回复消息

  Parameters

  • msg: V2NIMMessage

    消息对象

  Returns void

resetState

• resetState(): void

• Returns void

sendMessageActive

• sendMessageActive(params): Promise<void | V2NIMMessage>

• 发送消息

  Parameters

  • params: {
        conversationId: string;
        conversationType?: V2NIMConversationType;
        msg: V2NIMMessage;
        onAISend?: ((msg, aiConfig) => void);
        previewImg?: string;
        progress?: ((percentage) => boolean);
        sendBefore?: ((msg) => void);
        serverExtension?: Record<string, unknown>;
    }

    • conversationId: string

    • Optional conversationType?: V2NIMConversationType

    • msg: V2NIMMessage

    • Optional onAISend?: ((msg, aiConfig) => void)

      • • (msg, aiConfig): void

        • Parameters

          • msg: V2NIMMessageForUI

          • aiConfig: V2NIMMessageAIConfigParams

          Returns void

    • Optional previewImg?: string

    • Optional progress?: ((percentage) => boolean)

      • • (percentage): boolean

        • Parameters

          • percentage: number

          Returns boolean

    • Optional sendBefore?: ((msg) => void)

      • • (msg): void

        • Parameters

          • msg: V2NIMMessageForUI

          Returns void

    • Optional serverExtension?: Record<string, unknown>

  Returns Promise<void | V2NIMMessage>

sendMsgReceiptActive

• sendMsgReceiptActive(msg): Promise<void>

• 发送 p2p 消息已读回执

  Parameters

  • msg: V2NIMMessage

    消息对象

  Returns Promise<void>

sendTeamMsgReceiptActive

• sendTeamMsgReceiptActive(msgs): Promise<void>

• 发送群组消息已读回执

  Parameters

  • msgs: V2NIMMessage[]

    消息数组

  Returns Promise<void>

stopAIStreamMessageActive

• stopAIStreamMessageActive(message, params): Promise<void>

• 停止流式输出

  Parameters

  • message: V2NIMMessage

    消息体

  • params: V2NIMMessageAIStreamStopParams

    停止模式等入参

  Returns Promise<void>

unpinMessageActive

• unpinMessageActive(messageRefer, serverExtension?): Promise<void>

• 取消一条Pin消息

  Parameters

  • messageRefer: V2NIMMessageRefer

    需要被取消 pin 的消息摘要

  • Optional serverExtension: string

    扩展字段

  Returns Promise<void>

updateMsg

• updateMsg(conversationId, idClient, updateParam): void

• Parameters

  • conversationId: string

  • idClient: string

  • updateParam: Partial<V2NIMMessageForUI>

  Returns void

updatePinMessageActive

• updatePinMessageActive(message, serverExtension?): Promise<void>

• 取消一条Pin消息

  Parameters

  • message: V2NIMMessage

  • Optional serverExtension: string

    扩展字段

  Returns Promise<void>

voiceToTextActive

• voiceToTextActive(message): Promise<void>

• Parameters

  • message: V2NIMMessageForUI

  Returns Promise<void>