electronExtension | RongIMLib

Functions

getAllConversationList

getAllConversationList(channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>

- Defined in imlib-next/API/electronExtension/conversation.ts:15
获取全部会话列表

Parameters
- Optional channelId: string
  
  频道 ID，不传则获取全部频道 ID 类型
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getConversationList

getConversationList(startTime: number, count: number, channelId?: string, topPriority?: boolean): Promise<IAsyncRes<IAReceivedConversation[]>>

- Defined in imlib-next/API/electronExtension/conversation.ts:53
获取会话列表

Parameters
- startTime: number
  
  起始时间
- count: number
  
  数量
- Optional channelId: string
  
  频道 ID，不传则获取全部频道 ID 类型
- Optional topPriority: boolean
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

searchConversationByContent

searchConversationByContent(keyword: string, messageTypes: string[], channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>

- Defined in imlib-next/API/electronExtension/conversation.ts:109
根据消息内容搜索会话列表

Parameters
- keyword: string
  
  搜索关键字
- messageTypes: string[]
  
  消息类型
- Optional channelId: string
  
  频道 ID，不传则获取全部频道 ID 类型
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

searchMessages

searchMessages(conversation: IConversationOption, keyword: string, startTime: number, count: number, messageTypes?: string[]): Promise<IAsyncRes<{ messages: IAReceivedMessage[]; count: number | undefined }>>

- Defined in imlib-next/API/electronExtension/message.ts:28
搜索消息如果不传 channelId，则在所有 channelId 中搜索消息

Parameters
- conversation: IConversationOption
  
  会话
- keyword: string
  
  搜索关键字
- startTime: number
  
  搜索起始时间
- count: number
  
  数量
- Optional messageTypes: string[]
  
  消息类型，只支持文本（RC:TxtMsg）、文件（RC:FileMsg）、引用消息（RC:ReferenceMsg）、自定义消息
Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[]; count: number | undefined }>>

searchMessageInTimeRange

searchMessageInTimeRange(conversation: { conversationType: ConversationType; targetId: string }, option: ISearchMessageInTimeRangeOption): Promise<IAsyncRes<{ messages: IAReceivedMessage[] }>>

- Defined in imlib-next/API/electronExtension/message.ts:119
在时间范围内搜索消息

Parameters
- conversation: { conversationType: ConversationType; targetId: string }
  
  会话
  - conversationType: ConversationType
  - targetId: string
- option: ISearchMessageInTimeRangeOption
  
  配置
Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[] }>>

searchMessagesByUser

searchMessagesByUser(conversation: IConversationOption, userId: string, startTime: number, count: number): Promise<IAsyncRes<{ messages: IAReceivedMessage[] }>>

- Defined in imlib-next/API/electronExtension/message.ts:180
根据用户 ID 搜索消息

since
5.7.10

Parameters
- conversation: IConversationOption
  
  会话
- userId: string
- startTime: number
- count: number
Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[] }>>

getHistoryMessagesByMessageTypes

getHistoryMessagesByMessageTypes(conversation: IConversationOption, option: IGetHistoryMessagesByTypesOption): Promise<IAsyncRes<{ messages: IAReceivedMessage[] } & GetHistoryMessageResult>>

- Defined in imlib-next/API/electronExtension/message.ts:237
获取指定消息类型的历史消息

Parameters
- conversation: IConversationOption
  
  会话
- option: IGetHistoryMessagesByTypesOption
  
  配置参数
Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[] } & GetHistoryMessageResult>>

getContinuousMessages

getContinuousMessages(conversation: IConversationOption, options: GetHistoryMessageOption): Promise<IAsyncRes<{ list: IAReceivedMessage[]; timestamp: number; hasMore: boolean }>>

- Defined in imlib-next/API/electronExtension/message.ts:329
获取本地与远端历史消息(该接口已解决消息断档)
1. 分页获取时，下次传的时间戳必须使用 getContinuousMessages 接口返回的 timestamp
2. 获取历史消息逻辑：优先获取本地数据历史消息，本地获取不到再获取远端历史消息，但是该情况可能会因为离线或者补偿消息存储天数影响，出现消息断档现象消息断档现象：因为离线或者补偿消息存储天数影响，存储在本地数据库中消息存在不连续或者说中间某段时间消息丢失比如离线消息和补偿消息都为 1 天，第一天 A 给 B 发送 1, 2, 3，第二天 A 给 B 发送 4, 5, 6, B 第二天再登入，由于离线消息和补偿消息都为 1 天，所以 B 只能收到 4, 5, 6。 1, 2, 3 消息丢失
since
5.9.6

description
该接口需要业务层开启单群聊云存储服务
Parameters
- conversation: IConversationOption
- options: GetHistoryMessageOption
Returns Promise<IAsyncRes<{ list: IAReceivedMessage[]; timestamp: number; hasMore: boolean }>>

setMessageStatusToRead

setMessageStatusToRead(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<boolean>>

- Defined in imlib-next/API/electronExtension/message.ts:407
将自己发送的指定时间之前的消息标记对方已读，状态值为 SentStatus.READ

Parameters
- conversation: IConversationOption
  
  会话
- timestamp: number
  
  时间戳
Returns Promise<IAsyncRes<boolean>>

setMessageReceivedStatus

setMessageReceivedStatus(messageId: number, receivedStatus: ReceivedStatus): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:448
设置对方发送的消息自己的接受状态

deprecated
建议使用 setMessageReceivedStatusInfo, 支持设置多种状态

Parameters
- messageId: number
  
  消息 ID
- receivedStatus: ReceivedStatus
  
  接受状态
Returns Promise<IAsyncRes<void>>

setMessageReceivedStatusInfo

setMessageReceivedStatusInfo(messageId: number, receivedStatusInfo: IReceivedStatusInfo): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:479
设置对方发送的消息自己的接受状态信息

Parameters
- messageId: number
- receivedStatusInfo: IReceivedStatusInfo
Returns Promise<IAsyncRes<void>>

setMessageSentStatus

setMessageSentStatus(messageId: number, sentStatus: SentStatus): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:511
设置自己发送的消息的发送状态

Parameters
- messageId: number
  
  消息ID
- sentStatus: SentStatus
  
  发送状态
Returns Promise<IAsyncRes<void>>

setMessageContent

setMessageContent(messageId: number, content: Object, messageType?: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:536
修改消息内容

Parameters
- messageId: number
  
  消息 ID
- content: Object
  
  消息 content
- messageType: string = ''
  
  消息类型，如果设置了消息类型，会使该消息无法被搜索
Returns Promise<IAsyncRes<void>>

deleteMessages

deleteMessages(messageIds: number[]): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:564
删除消息

Parameters
- messageIds: number[]
  
  消息 ID 列表, 需是同一会话的消息
Returns Promise<IAsyncRes<void>>

clearMessages

clearMessages(conversation: IConversationOption): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:592
清空会话下历史消息

Parameters
- conversation: IConversationOption
  
  会话
Returns Promise<IAsyncRes<void>>

deleteMessagesByTimestamp

deleteMessagesByTimestamp(conversation: IConversationOption, timestamp: number, cleanSpace: boolean): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/electronExtension/message.ts:623
从本地消息数据库中删除某一会话指定时间之前的消息数据

Parameters
- conversation: IConversationOption
  
  会话
- timestamp: number
  
  指定删除该时间戳之前的消息
- cleanSpace: boolean
  
  指定删除该时间戳之前的消息。是否清理数据条目所使用的磁盘空间。清理磁盘空间会阻塞进程且耗时较长，不推荐使用。数据在被抹除的情况下，未清理的磁盘空间会在后续存储操作中复用，且对数据查询无影响
Returns Promise<IAsyncRes<void>>

insertMessage

insertMessage(conversation: IConversationOption, message: IAReceivedMessage | BaseMessage<any>, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/electronExtension/message.ts:779
向本地插入一条消息，不发送到服务器

Parameters
- conversation: IConversationOption
  
  会话
- message: IAReceivedMessage | BaseMessage<any>
  
  消息体
- options: IInsertOptions = {}
  
  注意：插入消息时，messageUid 将不会存入数据库
Returns Promise<IAsyncRes<IAReceivedMessage>>

batchInsertMessage

batchInsertMessage(messages: IInsertMessage[], checkDuplicate: boolean): Promise<IAsyncRes<boolean>>

- Defined in imlib-next/API/electronExtension/message.ts:918
批量向本地插入消息

Parameters
- messages: IInsertMessage[]
  
  批量插入的消息体
- checkDuplicate: boolean
  
  选择是否排重，默认 false
Returns Promise<IAsyncRes<boolean>>

getMessageCount

getMessageCount(conversation: IConversationOption): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/electronExtension/message.ts:1000
获取会话所有消息数

Parameters
- conversation: IConversationOption
Returns Promise<IAsyncRes<number>>

setCheckDuplicateMessage

setCheckDuplicateMessage(checkDuplicate?: boolean): Promise<IAsyncRes<boolean>>

- Defined in imlib-next/API/electronExtension/message.ts:1100
设置融云消息重排开关

发送方弱网情况下发送消息，消息到达服务但发送方没有收到服务 ack，导致发送方认为消息发送失败此种情况下，服务端和接收方都会收到第一条消息此时发送方重发该消息，再次达到服务，那么此时服务端会有两条消息（消息内容相同，messageUid 不同接收方会收到两条内容相同 messageUid 不同的消息，SDK 此时会把第二条相同内容消息排重掉以此来保证重发的相同内容消息，发送方只有一条消息，接收方也只有一条消息

当消息量少时，消息排重影响不大；但是本地存在大量消息时，排重会出现性能问题当本地存在大量消息，且发生收消息卡顿时，建议将排重关闭

description
Parameters
- Optional checkDuplicate: boolean
  
  是否使用融云消息重排机制 true: 开启, false: 关闭
Returns Promise<IAsyncRes<boolean>>
data => true: 成功，false: 失败

getMessagesAroundTimestamp

getMessagesAroundTimestamp(conversation: IConversationOption, option: { timestamp: number; beforeCount: number; afterCount: number }): Promise<IAsyncRes<IAReceivedMessage[]>>

- Defined in imlib-next/API/electronExtension/message.ts:1125
获取本地指定时间戳前后 N 条消息方法

Parameters
- conversation: IConversationOption
- option: { timestamp: number; beforeCount: number; afterCount: number }
  - timestamp: number
  - beforeCount: number
  - afterCount: number
Returns Promise<IAsyncRes<IAReceivedMessage[]>>
与移动端保持一致 beforeCount,afterCount 仅验证是否大于等于0，上限没做控制

clearLocalData

clearLocalData(): Promise<IAsyncRes<boolean>>

- Defined in imlib-next/API/electronExtension/other.ts:12
清除本地数据, 包括消息列表、会话列表、拉取消息的时间戳

Returns Promise<IAsyncRes<boolean>>
data => true: 成功，false: 失败

enable

enable(): boolean

- Defined in imlib-next/API/electronExtension/other.ts:34
获取是否使用 Electron 扩展

since
5.8.3

Returns boolean

Index

Functions

Functions

getAllConversationList

Parameters

Optional channelId: string

Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getConversationList

Parameters

startTime: number

count: number

Optional channelId: string

Optional topPriority: boolean

Returns Promise<IAsyncRes<IAReceivedConversation[]>>

searchConversationByContent

Parameters

keyword: string

messageTypes: string[]

Optional channelId: string

Returns Promise<IAsyncRes<IAReceivedConversation[]>>

searchMessages

Parameters

conversation: IConversationOption

keyword: string

startTime: number

count: number

Optional messageTypes: string[]

Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[]; count: number | undefined }>>

searchMessageInTimeRange

Parameters

conversation: { conversationType: ConversationType; targetId: string }

conversationType: ConversationType

targetId: string

option: ISearchMessageInTimeRangeOption

Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[] }>>

searchMessagesByUser

Parameters

conversation: IConversationOption

userId: string

startTime: number

count: number

Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[] }>>

getHistoryMessagesByMessageTypes

Parameters

conversation: IConversationOption

option: IGetHistoryMessagesByTypesOption

Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[] } & GetHistoryMessageResult>>

getContinuousMessages

Parameters

conversation: IConversationOption

options: GetHistoryMessageOption

Returns Promise<IAsyncRes<{ list: IAReceivedMessage[]; timestamp: number; hasMore: boolean }>>

setMessageStatusToRead

Parameters

conversation: IConversationOption

timestamp: number

Returns Promise<IAsyncRes<boolean>>

setMessageReceivedStatus

Parameters

messageId: number

receivedStatus: ReceivedStatus

Returns Promise<IAsyncRes<void>>

setMessageReceivedStatusInfo

Parameters

messageId: number

receivedStatusInfo: IReceivedStatusInfo

Returns Promise<IAsyncRes<void>>

setMessageSentStatus

Parameters

messageId: number

sentStatus: SentStatus

Returns Promise<IAsyncRes<void>>

setMessageContent

Parameters

messageId: number

content: Object

messageType: string = ''

Returns Promise<IAsyncRes<void>>

deleteMessages

Parameters