Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace electronExtension

Index

Functions

Functions

getAllConversationList

  • 获取全部会话列表

    Parameters

    • Optional channelId: string

      频道 ID，不传则获取全部频道 ID 类型

    Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getConversationList

  • 获取会话列表

    Parameters

    • startTime: number

      起始时间

    • count: number

      数量

    • Optional channelId: string

      频道 ID，不传则获取全部频道 ID 类型

    • Optional topPriority: boolean

    Returns Promise<IAsyncRes<IAReceivedConversation[]>>

searchConversationByContent

  • 根据消息内容搜索会话列表

    Parameters

    • keyword: string

      搜索关键字

    • messageTypes: string[]

      消息类型

    • Optional channelId: string

      频道 ID，不传则获取全部频道 ID 类型

    Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getConversations

  • 批量获取会话列表 仅支持单群聊系统会话

    Parameters

    • conversations: IConversationOption[]

      需要获取会话的信息 一次最多获取 100 个会话

    Returns Promise<IAsyncRes<IAReceivedConversation[]>>

    IReceivedConversation[]

searchMessages

  • 搜索消息 如果不传 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

searchMessagesByUser

  • 根据用户 ID 搜索消息

    since

    5.7.10

    Parameters

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

getHistoryMessagesByMessageTypes

getContinuousMessages

  • 获取本地与远端历史消息(该接口已解决消息断档)

    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

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

setMessageStatusToRead

  • 将自己发送的指定时间之前的消息标记对方已读，状态值为 SentStatus.READ

    Parameters

    Returns Promise<IAsyncRes<boolean>>

setMessageReceivedStatus

  • 设置对方发送的消息 自己的接受状态

    deprecated

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

    Parameters

    • messageId: number

      消息 ID

    • receivedStatus: ReceivedStatus

      接受状态

    Returns Promise<IAsyncRes<void>>

setMessageReceivedStatusInfo

  • 设置对方发送的消息 自己的接受状态信息

    Parameters

    Returns Promise<IAsyncRes<void>>

setMessageSentStatus

  • 设置自己发送的消息的发送状态

    Parameters

    • messageId: number

      消息ID

    • sentStatus: SentStatus

      发送状态

    Returns Promise<IAsyncRes<void>>

setMessageContent

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

  • 修改消息内容

    Parameters

    • messageId: number

      消息 ID

    • content: Object

      消息 content

    • messageType: string = ''

      消息类型，如果设置了消息类型，会使该消息无法被搜索

    Returns Promise<IAsyncRes<void>>

deleteMessages

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

  • 删除消息

    Parameters

    • messageIds: number[]

      消息 ID 列表, 需是同一会话的消息

    Returns Promise<IAsyncRes<void>>

clearMessages

  • 清空会话下历史消息

    Parameters

    Returns Promise<IAsyncRes<void>>

deleteMessagesByTimestamp

  • 从本地消息数据库中删除某一会话指定时间之前的消息数据

    Parameters

    • conversation: IConversationOption

      会话

    • timestamp: number

      指定删除该时间戳之前的消息

    • cleanSpace: boolean

      指定删除该时间戳之前的消息。是否清理数据条目所使用的磁盘空间。清理磁盘空间会阻塞进程且耗时较长，不推荐使用。 数据在被抹除的情况下，未清理的磁盘空间会在后续存储操作中复用，且对数据查询无影响

    Returns Promise<IAsyncRes<void>>

insertMessage

batchInsertMessage

  • 批量向本地插入消息

    Parameters

    • messages: IInsertMessage[]

      批量插入的消息体

    • checkDuplicate: boolean

      选择是否排重，默认 false

    Returns Promise<IAsyncRes<boolean>>

getMessageCount

  • 获取会话所有消息数

    Parameters

    Returns Promise<IAsyncRes<number>>

setCheckDuplicateMessage

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

  • 设置融云消息重排开关

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

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

    description

    Parameters

    • Optional checkDuplicate: boolean

      是否使用融云消息重排机制 true: 开启, false: 关闭

    Returns Promise<IAsyncRes<boolean>>

    data => true: 成功，false: 失败

setCheckChatRoomDuplicateMessage

  • setCheckChatRoomDuplicateMessage(checkDuplicate?: boolean): Promise<IAsyncRes<boolean>>

  • Parameters

    • Optional checkDuplicate: boolean

    Returns Promise<IAsyncRes<boolean>>

getMessagesAroundTimestamp

  • 获取本地指定时间戳前后 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>>

  • 清除本地数据, 包括消息列表、会话列表、拉取消息的时间戳

    Returns Promise<IAsyncRes<boolean>>

    data => true: 成功，false: 失败

enable

  • enable(): boolean

  • 获取是否使用 Electron 扩展

    since

    5.8.3

    Returns boolean