Class RCKitMessageStore

消息列表状态管理

Index

Methods

cancelSendMediaMessage clearMemoryData destroy forwardMessage getHistoryMsgList getMessages getSelectedMessages insertMessage recallMessage removeCatchedMessage sendMediaMessage sendMessage setSelectedMessages updateCatchedMessage

Methods

cancelSendMediaMessage

cancelSendMediaMessage(messageId: number): void
取消指定消息的上传请求
Parameters
- messageId: number
  消息ID
Returns void

clearMemoryData

clearMemoryData(): void
清理内存数据

Returns void

destroy

destroy(): void
Returns void

forwardMessage

forwardMessage(
conversationKey: string,
message: IAReceivedMessage,
): Promise<{ code: number; data?: IAReceivedMessage }>
转发消息
Parameters
- conversationKey: string
  会话ID
- message: IAReceivedMessage
  消息列表
Returns Promise<{ code: number; data?: IAReceivedMessage }>

getHistoryMsgList

getHistoryMsgList(
    conversationKey: string,
    endTime: number,
    lastMsgUId?: string,
    limit?: number,
): Promise<IAsyncRes<GetHistoryMessageResult>>
获取历史消息
Parameters
- conversationKey: string
  会话ID
- endTime: number
  结束时间戳, 精确到 ms
- OptionallastMsgUId: string
  上次查询的最后一条消息的 messageUId, 第一次不填
- limit: number = 20
  查询的数量, 默认 20
Returns Promise<IAsyncRes<GetHistoryMessageResult>>

getMessages

getMessages(conversationKey: string): IKitMessage[]
Parameters
- conversationKey: string
Returns IKitMessage[]

getSelectedMessages

getSelectedMessages(): IKitMessage[]
获取选中的消息

Returns IKitMessage[]

insertMessage

insertMessage(
    message: IKitMessageCache,
    isTrim?: boolean,
    isLog?: boolean,
): IKitMessageCache
从消息队列尾部插入一条消息，如果缓存中不存在消息所在会话，则不做任何操作
Parameters
- message: IKitMessageCache
  消息对象
- isTrim: boolean = true
  是否需要移除超出队列缓存上限部分，默认为 true
- isLog: boolean = true
Returns IKitMessageCache

recallMessage

recallMessage(message: IAReceivedMessage): Promise<RCResult<IAReceivedMessage>>
撤回消息
Parameters
- message: IAReceivedMessage
  消息对象
Returns Promise<RCResult<IAReceivedMessage>>

removeCatchedMessage

removeCatchedMessage(
    message: Pick<
        IAReceivedMessage,
        "messageUId"
        | "messageId"
        | "targetId"
        | "channelId"
        | "conversationType",
    >,
): void
移除一条缓存中的消息
Parameters
- message: Pick<
      IAReceivedMessage,
      "messageUId"
      | "messageId"
      | "targetId"
      | "channelId"
      | "conversationType",
  >
  消息对象
Returns void

sendMediaMessage

sendMediaMessage(
mediaOptions: IKitMediaMessageOptions,
): Promise<IAsyncRes<IAReceivedMessage>>
发送媒体消息
Parameters
- mediaOptions: IKitMediaMessageOptions
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendMessage

sendMessage(
    conversationKey: string,
    message: BaseMessage,
    options: ISendMessageOptions,
): Promise<IAsyncRes<IAReceivedMessage>>
发送消息
Parameters
- conversationKey: string
- message: BaseMessage
  消息实例
- options: ISendMessageOptions
Returns Promise<IAsyncRes<IAReceivedMessage>>

setSelectedMessages

setSelectedMessages(messages: IKitMessage[]): void
设置选中的消息
Parameters
- messages: IKitMessage[]
  消息列表
Returns void

updateCatchedMessage

updateCatchedMessage(message: IKitMessageCache): void
更新缓存中的消息，如果缓存中不存在则不做任何操作
Parameters
- message: IKitMessageCache
  消息对象
Returns void