RongIMLib - v5.9.8

Index

基础

会话

聊天室

超级群

会话未读数

草稿

黑名单

Enum

Interface

其他

基础

connect

connect(token: string, reconnectKickEnable?: boolean): Promise<IAsyncRes<{ userId: string }>>

- Defined in imlib-next/API/connect.ts:15
建立 IM 连接

Parameters
- token: string
- Optional reconnectKickEnable: boolean
  
  设置断线重连时是否踢出当前正在重连的设备 (仅 Electron 环境有效)
Returns Promise<IAsyncRes<{ userId: string }>>

disconnect

disconnect(closeDB?: boolean): Promise<void>

- Defined in imlib-next/API/connect.ts:42
断开当前用户的连接

description
调用后将不再接收消息，不可发送消息，不可获取历史消息，不可获取会话列表

Parameters
- Optional closeDB: boolean
  
  是否关闭数据库，默认为 true，仅 Electron 平台有效
Returns Promise<void>

addEventListener

addEventListener<T>(eventType: T, listener: EventListeners[T], target?: any): void

- Defined in imlib-next/API/events.ts:12
绑定事件

Type Parameters
- T extends Events
Parameters
- eventType: T
- listener: EventListeners[T]
- Optional target: any
Returns void

onceEventListener

onceEventListener<T>(eventType: T, listener: EventListeners[T], target?: any): void

- Defined in imlib-next/API/events.ts:20
绑定仅执行一次的事件

Type Parameters
- T extends Events
Parameters
- eventType: T
- listener: EventListeners[T]
- Optional target: any
Returns void

removeEventListener

removeEventListener<T>(eventType: T, listener: EventListeners[T], target?: any): void

- Defined in imlib-next/API/events.ts:28
移除事件

Type Parameters
- T extends Events
Parameters
- eventType: T
- listener: EventListeners[T]
- Optional target: any
Returns void

removeEventListeners

removeEventListeners(eventType: string): void

- Defined in imlib-next/API/events.ts:36
移除同一类型下的所有事件

Parameters
- eventType: string
Returns void

clearEventListeners

clearEventListeners(): void

- Defined in imlib-next/API/events.ts:44
清理所有事件

Returns void

getConnectionStatus

getConnectionStatus(): RCConnectionStatus

- Defined in imlib-next/API/init.ts:31
获取 IM 连接状态

Returns RCConnectionStatus

getServerTime

getServerTime(): number

- Defined in imlib-next/API/init.ts:40
当前服务器时间校准时间，可能存在误差

Returns number

getCurrentUserId

getCurrentUserId(): string

- Defined in imlib-next/API/init.ts:48
获取 IM 连接用户的 id

Returns string

getDeviceId

getDeviceId(): string

- Defined in imlib-next/API/init.ts:65
获取 deviceId

Returns string

installPlugin

installPlugin<T, O>(plugin: IPluginGenerator<T, O>, options: O): T | null

- Defined in imlib-next/API/install-plugin.ts:9
装载 plugin 插件，并返回相应的插件实例，需在调用 connect 方法之前使用

Type Parameters
- T
- O
Parameters
- plugin: IPluginGenerator<T, O>
- options: O
Returns T | null

会话

getConversationList

getConversationList(options?: { count?: number; startTime?: number; order?: 0 | 1 }, channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>

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

Parameters
- Optional options: { count?: number; startTime?: number; order?: 0 | 1 }
  - Optional count?: number
    
    会话数量
  - Optional startTime?: number
    
    获取起始时间默认值: 0 order 为 0 startTime 默认值为当前时间 order 为 1 startTime 默认值为所有会话中最早的消息时间
  - Optional order?: 0 | 1
    
    默认值: 0 0 获取 startTime 之前的 1 获取 startTime 之后的
- Optional channelId: string
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getConversation

getConversation(options: IConversationOption): Promise<IAsyncRes<IAReceivedConversation | null | undefined>>

- Defined in imlib-next/API/conversation.ts:78
获取指定会话数据

description
通过该方法获取的会话可能并不存在于当前的会话列表中，此处只作为功能性封装语法糖

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<IAReceivedConversation | null | undefined>>

removeConversation

removeConversation(options: IConversationOption): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:110
移除指定的会话实例

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

setConversationNotificationLevel

setConversationNotificationLevel(options: IConversationOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:561
设置会话免打扰原： setConversationNotificationStatus 已废弃是否免打扰
- -1: 全部消息通知（接收全部消息通知 -- 显示指定关闭免打扰功能）
- 0: 未设置（向上查询群或者APP级别设置）//存量数据中0表示未设置
- 1: 群聊超级群仅@消息通知（现在通知）单聊代表全部消息通知
- 2: @ 指定用户通知
- 3: @ 群用户组通知，通知用户组暂未实现，暂不暴露出去
- 4: @ 群全员通知
- 5: 消息通知被屏蔽，即不接收消息通知
Parameters
- options: IConversationOption
- notificationLevel: NotificationLevel
Returns Promise<IAsyncRes<void>>

setConversationNotificationStatus

setConversationNotificationStatus(options: IConversationOption, notificationStatus: NotificationStatus): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:686
设置会话免打扰
deprecated
已废弃，请使用 setConversationNotificationLevel 原： setConversationStatus，免打扰和置顶一体的是否免打扰
- 1: 开启免打扰
- 2: 关闭免打扰
Parameters
- options: IConversationOption
- notificationStatus: NotificationStatus
Returns Promise<IAsyncRes<void>>

getConversationNotificationLevel

getConversationNotificationLevel(options: IConversationOption): Promise<IAsyncRes<NotificationLevel | undefined>>

- Defined in imlib-next/API/conversation.ts:717
查询指定会话和频道免打扰原： getConversationNotificationStatus 已废弃

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<NotificationLevel | undefined>>

getConversationNotificationStatus

getConversationNotificationStatus(options: IConversationOption): Promise<IAsyncRes<NotificationStatus | undefined>>

- Defined in imlib-next/API/conversation.ts:750
获取免打扰状态 getConversationNotificationStatus

deprecated
已废弃，请使用 getConversationNotificationLevel

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<NotificationStatus | undefined>>

getBlockedConversationList

getBlockedConversationList(): Promise<IAsyncRes<IBaseConversationInfo[]>>

- Defined in imlib-next/API/conversation.ts:781
获取免打扰状态列表 getBlockedConversationList

Returns Promise<IAsyncRes<IBaseConversationInfo[]>>

setConversationToTop

setConversationToTop(options: IConversationOption, isTop?: boolean, isUpdateTime?: boolean): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:793
设置会话是否置顶

Parameters
- options: IConversationOption
  
  回话信息
- isTop: boolean = true
  
  置顶状态
- isUpdateTime: boolean = true
  
  是否更新会话操作时间，默认为更新，仅私有云环境有效
Returns Promise<IAsyncRes<void>>

getTopConversationList

getTopConversationList(conversationTypes?: ConversationType[], channelId?: string): Promise<IAsyncRes<IAReceivedConversation[]>>

- Defined in imlib-next/API/conversation.ts:931
获取置顶会话

Parameters
- Optional conversationTypes: ConversationType[]
  
  会话类型
- Optional channelId: string
  
  不传或传 undefined 时获取全部 channelId 类型的置顶会话
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getUnreadConversationList

getUnreadConversationList(conversationTypes?: ConversationType[]): Promise<IAsyncRes<IAReceivedConversation[]>>

- Defined in imlib-next/API/conversation.ts:972
获取未读会话列表

Parameters
- Optional conversationTypes: ConversationType[]
  
  会话类型
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getAllConversationState

getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>

- Defined in imlib-next/API/conversation.ts:1064
获取本地全部会话的状态

Returns Promise<IAsyncRes<IConversationState[]>>

消息

sendMessage

sendMessage(conversation: IConversationOption, message: BaseMessage<any>, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:63
发送消息

Parameters
- conversation: IConversationOption
- message: BaseMessage<any>
- Optional options: ISendMessageOptions
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendTextMessage

sendTextMessage(conversation: IConversationOption, messageBody: ITextMessageBody, options?: ISendMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:192
发送文本消息

Parameters
- conversation: IConversationOption
- messageBody: ITextMessageBody
- Optional options: ISendMessageOptions
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendFileMessage

sendFileMessage(conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks, sendOptions?: IUploadMessageOption): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:292
发送文件消息

Parameters
- conversation: IConversationOption
- msgBody: ISendBody
- Optional hooks: IUploadHooks
- Optional sendOptions: IUploadMessageOption
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendImageMessage

sendImageMessage(conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks, sendOptions?: IImageMessageOption): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:313
发送图片消息

Parameters
- conversation: IConversationOption
- msgBody: ISendBody
- Optional hooks: IUploadHooks
- Optional sendOptions: IImageMessageOption
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendGIFMessage

sendGIFMessage(conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks, sendOptions?: IUploadMessageOption): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:333
发送 GIF图片消息

Parameters
- conversation: IConversationOption
- msgBody: ISendBody
- Optional hooks: IUploadHooks
- Optional sendOptions: IUploadMessageOption
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendHQVoiceMessage

sendHQVoiceMessage(conversation: IConversationOption, msgBody: ISendBody, hooks?: IUploadHooks, sendOptions?: IUploadMessageOption): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:356
发送高清语音消息，待发送的文件必须为 AAC 音频文件

Parameters
- conversation: IConversationOption
- msgBody: ISendBody
- Optional hooks: IUploadHooks
- Optional sendOptions: IUploadMessageOption
Returns Promise<IAsyncRes<IAReceivedMessage>>

sendSightMessage

sendSightMessage(conversation: IConversationOption, msgBody: ISendSightMessageOptions, hooks?: IUploadHooks, sendOptions?: IUploadMessageOption): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:379
发送小视频消息

description
发送的小视频消息必须是 MP4 文件，且音频编码为 AAC，视频编码 H264，否则可能造成 iOS 或 Android 接收后不可播放问题

Parameters
- conversation: IConversationOption
- msgBody: ISendSightMessageOptions
- Optional hooks: IUploadHooks
- Optional sendOptions: IUploadMessageOption
Returns Promise<IAsyncRes<IAReceivedMessage>>

getHistoryMessages

getHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>

- Defined in imlib-next/API/message.ts:426
获取历史消息 Electron 获取的是本地数据库 Web 获取的是远端历史消息

Parameters
- conversation: IConversationOption
- Optional options: GetHistoryMessageOption
Returns Promise<IAsyncRes<GetHistoryMessageResult>>

getRemoteHistoryMessages

getRemoteHistoryMessages(conversation: IConversationOption, options?: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>

- Defined in imlib-next/API/message.ts:496
获取远程历史消息

Parameters
- conversation: IConversationOption
- Optional options: GetHistoryMessageOption
Returns Promise<IAsyncRes<GetHistoryMessageResult>>

sendReadReceiptMessage

sendReadReceiptMessage(targetId: string, messageUId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:561
发送单聊已读回执

Parameters
- targetId: string
- messageUId: string
- timestamp: number
- Optional channelId: string
Returns Promise<IAsyncRes<void>>

sendReadReceiptRequest

sendReadReceiptRequest(targetId: string, messageUId: string, channelId?: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:596
发送群已读回执请求

Parameters
- targetId: string
- messageUId: string
- Optional channelId: string
Returns Promise<IAsyncRes<void>>

sendReadReceiptResponse

sendReadReceiptResponse(targetId: string, messageUIds: string[], channelId?: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:628
deprecated
已废弃，请使用 sendReadReceiptResponseV2

Parameters
- targetId: string
- messageUIds: string[]
- Optional channelId: string
Returns Promise<IAsyncRes<void>>

sendReadReceiptResponseV2

sendReadReceiptResponseV2(targetId: string, messageList?: {}, channelId?: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:676
发送群阅读回执响应V2

Parameters
- targetId: string
  
  群组Id
- Optional messageList: {}
  
  要回执的消息列表，结构为： {senderUserId: [messageUId1, messageUId2]}
  - [senderUserId: string]: string[]
- Optional channelId: string
Returns Promise<IAsyncRes<void>>

recallMessage

recallMessage(conversation: IConversationOption, options: IRecallMessageOptions): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:977
撤回消息

Parameters
- conversation: IConversationOption
- options: IRecallMessageOptions
Returns Promise<IAsyncRes<IAReceivedMessage>>

deleteMessages

deleteMessages(conversation: IConversationOption, messages: { messageUId: string; sentTime: number; messageDirection: MessageDirection }[]): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:1037
按消息 UId 删除消息

Parameters
- conversation: IConversationOption
- messages: { messageUId: string; sentTime: number; messageDirection: MessageDirection }[]
Returns Promise<IAsyncRes<void>>

clearHistoryMessages

clearHistoryMessages(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:1104
按时间戳删除消息

Parameters
- conversation: IConversationOption
  
  会话
- timestamp: number
  
  清除时间点, 该时间之前的消息将被清除
Returns Promise<IAsyncRes<void>>

updateMessageExpansion

updateMessageExpansion(expansion: {}, message: IAReceivedMessage): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:1224
更新（添加、替换）消息扩展属性

Parameters
- expansion: {}
  
  要更新的消息扩展信息键值对
  - [key: string]: any
- message: IAReceivedMessage
  
  要更新的原始消息体
Returns Promise<IAsyncRes<void>>

removeMessageExpansionForKey

removeMessageExpansionForKey(keys: string[], message: IAReceivedMessage): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:1273
删除扩展存储

params
keys 需删除消息扩展的 keys

params
message 原始消息体

Parameters
- keys: string[]
- message: IAReceivedMessage
Returns Promise<IAsyncRes<void>>

sendTypingStatusMessage

sendTypingStatusMessage(conversation: IConversationOption, typingContentType: string): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:1320
发送typing消息

Parameters
- conversation: IConversationOption
- typingContentType: string
  
  输入状态消息类型
Returns Promise<IAsyncRes<IAReceivedMessage>>

getMessageReader

getMessageReader(targetId: string, messageUId: string, channelId: string): Promise<IAsyncRes<IMessageReaderResponse>>

- Defined in imlib-next/API/message.ts:1378
获取群已读列表

Parameters
- targetId: string
- messageUId: string
  
  消息UID
- channelId: string
Returns Promise<IAsyncRes<IMessageReaderResponse>>

registerMessageType

registerMessageType<T>(messageType: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): (new (content: T) => BaseMessage<T>)

- Defined in imlib-next/API/message.ts:1416
注册自定义消息

Type Parameters
- T
Parameters
- messageType: string
  
  消息类型
- isPersited: boolean
  
  是否存储
- isCounted: boolean
  
  是否计数
- Optional searchProps: string[]
  
  可搜索的属性
- Optional isStatusMessage: boolean
  
  是否状态消息，状态消息不计数，不存储，仅在线能收到
Returns (new (content: T) => BaseMessage<T>)
- - new (content: T): BaseMessage<T>
  - Parameters
    - content: T
    Returns BaseMessage<T>

getFirstUnreadMessage

getFirstUnreadMessage(conversation: IConversationOption): Promise<IAsyncRes<IAReceivedMessage | null>>

- Defined in imlib-next/API/message.ts:1444
获取第一条未读消息

Parameters
- conversation: IConversationOption
Returns Promise<IAsyncRes<IAReceivedMessage | null>>

getFirstUnreadMessageInfo

getFirstUnreadMessageInfo(conversation: IConversationOption): Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>

- Defined in imlib-next/API/message.ts:1486
获取第一条未读消息信息

since
5.9.0

Parameters
- conversation: IConversationOption
  
  当没有未读消息时，返回的 data 为 null 当第一条未读消息被撤回时，此信息不会更新
Returns Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>

insertMessage

insertMessage(conversation: IConversationOption, content: IReceivedMessage, options?: IInsertOptions): Promise<IAsyncRes<IAReceivedMessage>>

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

deprecated
Parameters
- conversation: IConversationOption
- content: IReceivedMessage
  
  消息体
- options: IInsertOptions = {}
Returns Promise<IAsyncRes<IAReceivedMessage>>

getMessage

getMessage(messageId: string | number): Promise<IAsyncRes<IAReceivedMessage>>

- Defined in imlib-next/API/message.ts:1599
获取消息

Parameters
- messageId: string | number
  
  本地消息 ID 或 messageUId
Returns Promise<IAsyncRes<IAReceivedMessage>>

getUnreadMentionedMessages

getUnreadMentionedMessages(conversation: IConversationOption): IAsyncRes<IAReceivedMessage[]>

- Defined in imlib-next/API/message.ts:1629
获取会话下所有未读的 @ 消息

Parameters
- conversation: IConversationOption
Returns IAsyncRes<IAReceivedMessage[]>

searchMessages

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

- Defined in imlib-next/API/message.ts:1670
按关键字搜索会话内的消息

deprecated
已废弃，推荐使用 electronExtension.searchMessages 方法

deprecated
Parameters
- conversation: IConversationOption
  
  会话
- keyword: string
  
  搜索内容
- timestamp: number
  
  搜索时间, 搜索该时间之前的消息
- count: number
  
  获取的数量
Returns Promise<IAsyncRes<{ messages: IAReceivedMessage[]; count: number | undefined }>>

deleteLocalMessagesByTimestamp

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

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

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

clearMessages

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

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

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

searchConversationByContent

searchConversationByContent(keyword: string, conversationTypes?: ConversationType[], messageTypes?: string[], channelId?: string): Promise<IAsyncRes<IReceivedConversation[] | undefined>>

- Defined in imlib-next/API/message.ts:1816
按内容搜索会话

deprecated
Parameters
- keyword: string
  
  关键字
- Optional conversationTypes: ConversationType[]
  
  会话类型数组
- Optional messageTypes: string[]
- Optional channelId: string
Returns Promise<IAsyncRes<IReceivedConversation[] | undefined>>

clearUnreadCountByTimestamp

clearUnreadCountByTimestamp(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/message.ts:1877
清除时间戳前的未读数

Parameters
- conversation: IConversationOption
- timestamp: number
  
  目标 ID
Returns Promise<IAsyncRes<void>>

setMessageReceivedStatus

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

- Defined in imlib-next/API/message.ts:1921
设置消息接收状态

deprecated
Parameters
- messageId: number
- receivedStatus: number
Returns Promise<IAsyncRes<void>>

聊天室

joinChatRoom

joinChatRoom(targetId: string, options: { count: number }): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:20
加入聊天室

deprecated
Parameters
- targetId: string
- options: { count: number }
  - count: number
    
    拉取消息数
Returns Promise<IAsyncRes<void>>

joinExistChatRoom

joinExistChatRoom(targetId: string, options: { count: number }): Promise<IAsyncRes<IChatroomJoinResponse>>

- Defined in imlib-next/API/chatroom.ts:55
加入已存在的聊天室

Parameters
- targetId: string
- options: { count: number }
  - count: number
    
    拉取消息数
Returns Promise<IAsyncRes<IChatroomJoinResponse>>

quitChatRoom

quitChatRoom(targetId: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:91
退出聊天室

Parameters
- targetId: string
Returns Promise<IAsyncRes<void>>

getChatRoomInfo

getChatRoomInfo(targetId: string, options?: { count?: number; order?: 0 | 1 | 2 }): Promise<IAsyncRes<IChatroomInfo>>

- Defined in imlib-next/API/chatroom.ts:117
获取聊天室房间数据

description
count 或 order 有一个为0时,只返回成员总数，不返回成员列表信息

Parameters
- targetId: string
- Optional options: { count?: number; order?: 0 | 1 | 2 }
  - Optional count?: number
    
    获取聊天室的人数，传值范围：0-20，默认为 0
  - Optional order?: 0 | 1 | 2
    聊天室的人员排序，默认为 0
    
    1: 升序
    
    2: 降序
Returns Promise<IAsyncRes<IChatroomInfo>>

setChatRoomEntry

setChatRoomEntry(targetId: string, options: IChatroomEntry): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:161
设置聊天室自定义属性

description
仅聊天室中不存在此属性或属性设置者为己方时可设置成功

Parameters
- targetId: string
- options: IChatroomEntry
Returns Promise<IAsyncRes<void>>

setChatRoomEntries

setChatRoomEntries(targetId: string, options: IChatroomEntries): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:197
批量设置聊天室自定义属性

Parameters
- targetId: string
- options: IChatroomEntries
  
  ISetChatroomEntryOption数组
Returns Promise<IAsyncRes<void>>

forceSetChatRoomEntry

forceSetChatRoomEntry(targetId: string, options: IChatroomEntry): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:241
强制增加/修改任意聊天室属性

description
仅聊天室中不存在此属性或属性设置者为己方时可设置成功

Parameters
- targetId: string
- options: IChatroomEntry
Returns Promise<IAsyncRes<void>>

removeChatRoomEntry

removeChatRoomEntry(targetId: string, options: IRemoveChatroomEntry): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:280
删除聊天室属性

description
仅限于删除自己设置的聊天室属性

Parameters
- targetId: string
- options: IRemoveChatroomEntry
Returns Promise<IAsyncRes<void>>

removeChatRoomEntries

removeChatRoomEntries(targetId: string, options: { entries: string[]; notificationExtra?: string }): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:314
批量删除聊天室属性

description
仅限于删除自己设置的聊天室属性

Parameters
- targetId: string
- options: { entries: string[]; notificationExtra?: string }
  - entries: string[]
  - Optional notificationExtra?: string
Returns Promise<IAsyncRes<void>>

forceRemoveChatRoomEntry

forceRemoveChatRoomEntry(targetId: string, options: IRemoveChatroomEntry): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:359
强制删除聊天室内的任意属性

description
Parameters
- targetId: string
- options: IRemoveChatroomEntry
Returns Promise<IAsyncRes<void>>

getChatRoomEntry

getChatRoomEntry(targetId: string, key: string): Promise<IAsyncRes<string | number | boolean>>

- Defined in imlib-next/API/chatroom.ts:393
获取聊天室的指定属性

Parameters
- targetId: string
- key: string
Returns Promise<IAsyncRes<string | number | boolean>>

getAllChatRoomEntries

getAllChatRoomEntries(targetId: string): Promise<IAsyncRes<{}>>

- Defined in imlib-next/API/chatroom.ts:423
获取聊天室的所有属性

Parameters
- targetId: string
Returns Promise<IAsyncRes<{}>>

getChatroomHistoryMessages

getChatroomHistoryMessages(targetId: string, options: GetHistoryMessageOption): Promise<IAsyncRes<GetHistoryMessageResult>>

- Defined in imlib-next/API/chatroom.ts:448
获取聊天室的历史消息

Parameters
- targetId: string
- options: GetHistoryMessageOption
Returns Promise<IAsyncRes<GetHistoryMessageResult>>

bindRTCRoomForChatroom

bindRTCRoomForChatroom(option: IRTCRoomBindOption): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/chatroom.ts:510
将聊天室和 RTC 房间绑定

Parameters
- option: IRTCRoomBindOption
Returns Promise<IAsyncRes<void>>

超级群

getUltraGroupList

getUltraGroupList(options?: IGetUltraGroupListOption): Promise<IAsyncRes<IUltraGroupConversation[]>>

- Defined in imlib-next/API/UltraGroup.ts:18
获取超级群会话列表

Parameters
- options: IGetUltraGroupListOption = {}
Returns Promise<IAsyncRes<IUltraGroupConversation[]>>

getBlockUltraGroupList

getBlockUltraGroupList(): Promise<IAsyncRes<IBaseConversationInfo[]>>

- Defined in imlib-next/API/UltraGroup.ts:55
获取超级群免打扰列表

Returns Promise<IAsyncRes<IBaseConversationInfo[]>>

sendUltraGroupTypingStatus

sendUltraGroupTypingStatus(options: IConversationOption): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/UltraGroup.ts:76
通知服务端正在输入中

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

getUltraGroupMessageListByMessageUId

getUltraGroupMessageListByMessageUId(options: IConversationOption, messages: IMessageDesc[]): Promise<IAsyncRes<{}>>

- Defined in imlib-next/API/UltraGroup.ts:104
根据消息 ID 获取消息

Parameters
- options: IConversationOption
- messages: IMessageDesc[]
Returns Promise<IAsyncRes<{}>>

updateExpansionForUltraGroupMessage

updateExpansionForUltraGroupMessage(expansion: {}, message: IAReceivedMessage): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/UltraGroup.ts:152
修改消息扩展

Parameters
- expansion: {}
  - [key: string]: any
- message: IAReceivedMessage
Returns Promise<IAsyncRes<void>>

removeExpansionForUltraGroupMessage

removeExpansionForUltraGroupMessage(expansion: string[], message: IAReceivedMessage): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/UltraGroup.ts:194
删除消息扩展

Parameters
- expansion: string[]
- message: IAReceivedMessage
Returns Promise<IAsyncRes<void>>

removeAllExpansionForUltraGroupMessage

removeAllExpansionForUltraGroupMessage(message: IAReceivedMessage): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/UltraGroup.ts:235
删除指定消息上的所有扩展

Parameters
- message: IAReceivedMessage
Returns Promise<IAsyncRes<void>>

modifyMessage

modifyMessage(content: {}, message: IAReceivedMessage): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/UltraGroup.ts:271
修改消息

Parameters
- content: {}
  - [key: string]: any
- message: IAReceivedMessage
Returns Promise<IAsyncRes<void>>

getUltraGroupUnreadMentionedCountByTargetId

getUltraGroupUnreadMentionedCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/UltraGroup.ts:316
获取超级群所有子频道的未读数

Parameters
- targetId: string
  
  超级群 Id
- Optional notificationLevels: NotificationLevel[]
  
  免打扰级别，不传或传空数组则获取全部级别
Returns Promise<IAsyncRes<number>>

getUltraGroupDefaultNotificationLevel

getUltraGroupDefaultNotificationLevel(options: IUltraGroupOption): Promise<IAsyncRes<NotificationLevel>>

- Defined in imlib-next/API/UltraGroup.ts:355
查询指定超级群默认通知配置

Parameters
- options: IUltraGroupOption
Returns Promise<IAsyncRes<NotificationLevel>>

setUltraGroupDefaultNotificationLevel

setUltraGroupDefaultNotificationLevel(options: IUltraGroupOption, notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/UltraGroup.ts:391
设置指定超级群默认通知配置

Parameters
- options: IUltraGroupOption
  - 设置超级群默认通知配置 options: { targetId: 'xxx' }, channelId 不传或传 ''
  - 设置超级群指定频道默认通知配置 options: { targetId: 'xxx', channelId: 'xxx' }
- notificationLevel: NotificationLevel
  - NotificationLevel
Returns Promise<IAsyncRes<void>>

getUltraGroupUnreadCountByTargetId

getUltraGroupUnreadCountByTargetId(targetId: string, notificationLevels?: NotificationLevel[]): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/UltraGroup.ts:435
获取指定超级群所有频道未读数

Parameters
- targetId: string
  
  超级群 Id
- Optional notificationLevels: NotificationLevel[]
  
  免打扰级别，不传或传空数组则获取全部级别
Returns Promise<IAsyncRes<number>>
未读数

getAllUltraGroupUnreadCount

getAllUltraGroupUnreadCount(): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/UltraGroup.ts:472
超级群类型所有未读数

Returns Promise<IAsyncRes<number>>
未读数

getAllUltraGroupUnreadMentionedCount

getAllUltraGroupUnreadMentionedCount(): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/UltraGroup.ts:497
超级群类型所有 @ 消息未读数

Returns Promise<IAsyncRes<number>>
未读数

getUltraGroupUnreadMentionedMessages

getUltraGroupUnreadMentionedMessages(options: IUltraGroupUnreadMentionedOption): Promise<IAsyncRes<IUltraUnreadMsg[]>>

- Defined in imlib-next/API/UltraGroup.ts:524
超级群获取指定会话未读 @ 消息列表

Parameters
- options: IUltraGroupUnreadMentionedOption
Returns Promise<IAsyncRes<IUltraUnreadMsg[]>>
指定会话 @ 未读数消息列表

getUltraGroupFirstUnreadMessageTimestamp

getUltraGroupFirstUnreadMessageTimestamp(conversation: IUltraGroupOption): Promise<IAsyncRes<IUltraUnreadMsg>>

- Defined in imlib-next/API/UltraGroup.ts:565
超级群获取指定会话第一条未读消息时间戳

Parameters
- conversation: IUltraGroupOption
Returns Promise<IAsyncRes<IUltraUnreadMsg>>
指定会话第一条未读消息时间戳

会话未读数

getTotalUnreadCount

getTotalUnreadCount(includeMuted?: boolean, conversationTypes?: ConversationType[]): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/conversation.ts:334
获取当前所有会话的消息未读数
description
1. 清除浏览器缓存会导致会话未读数不准确
2. 会话消息未读数存储在 WebStorage 中, 若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
3. 其他端删除会话可能会导致会话未读数不准确
Parameters
- Optional includeMuted: boolean
  
  是否包含免打扰会话
- Optional conversationTypes: ConversationType[]
  
  要获取未读数的会话类型，若为空，则默认获取单聊、群聊及系统消息未读数
Returns Promise<IAsyncRes<number>>

getTotalUnreadCountByLevels

getTotalUnreadCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[]): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/conversation.ts:370
获取会话指定免打扰级别的未读数

Parameters
- conversationTypes: ConversationType[]
  
  会话类型列表
- levels: NotificationLevel[]
  
  免打扰级别列表，传空数组则获取全部免打扰级别未读数
Returns Promise<IAsyncRes<number>>
number 未读总数

getTotalUnreadMentionedCountByLevels

getTotalUnreadMentionedCountByLevels(conversationTypes: ConversationType[], levels: NotificationLevel[]): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/conversation.ts:414
获取会话指定免打扰级别未读 @ 消息数

Parameters
- conversationTypes: ConversationType[]
  
  会话类型列表
- levels: NotificationLevel[]
  
  免打扰级别列表，传空数组则获取全部免打扰级别未读数
Returns Promise<IAsyncRes<number>>
number 未读总数

getUnreadCount

getUnreadCount(options: IConversationOption): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/conversation.ts:455
获取单个会话的未读数

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

clearMessagesUnreadStatus

clearMessagesUnreadStatus(options: IConversationOption): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:485
清除会话未读数原：clearUnreadCount

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

clearAllMessagesUnreadStatus

clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>

- Defined in imlib-next/API/conversation.ts:516
清理全部未读数

Returns Promise<IAsyncRes<ErrorCode>>

getUnreadMentionedCount

getUnreadMentionedCount(options: IConversationOption): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/conversation.ts:1018
获取单个群会话 @ 消息未读数

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

getAllUnreadMentionedCount

getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>

- Defined in imlib-next/API/conversation.ts:1047
获取所有群会话 @ 消息未读数

Returns Promise<IAsyncRes<number>>

草稿

getTextMessageDraft

getTextMessageDraft(options: IConversationOption): Promise<IAsyncRes<string>>

- Defined in imlib-next/API/conversation.ts:228
获取会话文本草稿

params
conversationType 会话类型

params
targetId 目标 ID

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<string>>

saveTextMessageDraft

saveTextMessageDraft(options: IConversationOption, draft: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:260
设置会话文本草稿

params
conversationType 会话类型

params
targetId 目标 ID

params
draft 草稿内容

Parameters
- options: IConversationOption
- draft: string
Returns Promise<IAsyncRes<void>>

clearTextMessageDraft

clearTextMessageDraft(options: IConversationOption): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/conversation.ts:299
删除会话文本草稿

params
conversationType 会话类型

params
targetId 目标 ID

Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

黑名单

addToBlacklist

addToBlacklist(userId: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/blackList.ts:16
添加用户到黑名单

Parameters
- userId: string
  
  用户 ID
Returns Promise<IAsyncRes<void>>

removeFromBlacklist

removeFromBlacklist(userId: string): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/blackList.ts:36
从黑名单中移除用户

Parameters
- userId: string
  
  用户 ID
Returns Promise<IAsyncRes<void>>

getBlacklist

getBlacklist(): Promise<IAsyncRes<string[]>>

- Defined in imlib-next/API/blackList.ts:55
获取黑名单列表

Returns Promise<IAsyncRes<string[]>>

getBlacklistStatus

getBlacklistStatus(userId: string): Promise<IAsyncRes<boolean>>

- Defined in imlib-next/API/blackList.ts:80
查询用户是否在黑名单中

Parameters
- userId: string
  
  用户 ID
Returns Promise<IAsyncRes<boolean>>

其他

IChatroomRejoinedInfo

IChatroomRejoinedInfo: IChatroomRejoinedFailed | IChatroomRejoinedSuccessed

IPromiseResult

IPromiseResult<T>: Promise<IAsyncRes<T>>

异步任务结果定义

description: 通过 Promise.resolve 来处理预期内的异常，进而通过 Uncatch Promise Error 暴露预期外的异常

Type Parameters

T = void

IRemoveChatRoomEntries

IRemoveChatRoomEntries: IRemoveChatroomEntries

定义已废弃，请使用 IRemoveChatroomEntries 替换

deprecated

IChatRoomEntry

IChatRoomEntry: IChatroomEntry

定义已废弃，请使用 IChatroomEntry 替换

deprecated

IChatRoomEntries

IChatRoomEntries: IChatroomEntries

定义已废弃，请使用 IChatroomEntries 替换

deprecated

IRemoveChatRoomEntry

IRemoveChatRoomEntry: IRemoveChatroomEntry

定义已废弃，请使用 IRemoveChatroomEntry 替换

deprecated

EnableLogL

EnableLogL: DEBUG | INFO | WARN | ERROR

有效的日志等级声明

IEventListener

IEventListener: ((...args: any[]) => void)

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

getUltraGroupUnreadInfoList

getUltraGroupUnreadInfoList(targetIds: string[]): Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>

- Defined in imlib-next/API/UltraGroup.ts:599
根据超级群的 targetId 数组，获取每个超级群下所有频道会话信息

since
5.7.10

Parameters
- targetIds: string[]
Returns Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>

init

init(options: IInitOption): void

- Defined in imlib-next/API/init.ts:10
Parameters
- options: IInitOption
Returns void

destroy

destroy(): Promise<void>

- Defined in imlib-next/API/init.ts:17
反初始化

Returns Promise<void>

__addSDKVersion

__addSDKVersion(name: string, version: string): void

- Defined in imlib-next/API/init.ts:57
（内部方法）用于统计各组件版本信息

Parameters
- name: string
- version: string
Returns void

ISendBody

ISendBody: IUserInfo & IExtraData & { file: File } & IMentionedInfo & IAuditInfo

ISendFileMessageOptions

ISendFileMessageOptions: ISendBody

ISendImageMessageOptions

ISendImageMessageOptions: ISendBody

ISendSightMessageOptions

ISendSightMessageOptions: { duration: number; thumbnail: string; name?: string } & ISendBody

sendSyncReadStatusMessage

sendSyncReadStatusMessage(conversation: IConversationOption, timestamp: number): Promise<IAsyncRes<void>>

多端同步阅读状态

example

const con = {
  conversationType: ConversationType.Group,
  targetId: 'targetId'
}
sendSyncReadStatusMessage(con, Date.now()).then(res => {
  if (res.code === ErrorCode.success) {
    console.log('send success', res.data)
  } else {
    console.log('send error', res.msg)
  }
})

Parameters

conversation: IConversationOption

会话信息
timestamp: number

时间戳

Returns Promise<IAsyncRes<void>>

CombineMessage

CombineMessage: MessageConstructor<ICombineMessageBody>

CombineV2MessageContent

CombineV2MessageContent: ICombineV2MessageContent & IExtraData & IUserInfo & IMentionedInfo

MessageConstructor

MessageConstructor<T>: (new (content: T) => BaseMessage<T>)

Type Parameters

Type declaration

- new (content: T): BaseMessage<T>
- Parameters
  - content: T
  Returns BaseMessage<T>

setProxy

setProxy(proxy: null | IProxy): IPromiseResult<IProxy>

- Defined in imlib-next/API/proxy.ts:12
设置代理

Parameters
- proxy: null | IProxy
Returns IPromiseResult<IProxy>

getProxy

getProxy(): IPromiseResult<IProxy>

- Defined in imlib-next/API/proxy.ts:48
获取代理

Returns IPromiseResult<IProxy>

testProxy

testProxy(proxy: IProxy, testHost: string): IPromiseResult<IResponse>

- Defined in imlib-next/API/proxy.ts:70
测试代理

Parameters
- proxy: IProxy
- testHost: string
Returns IPromiseResult<IResponse>

subscribeUserStatus

subscribeUserStatus(userIds: string[], subscribeType: ONLINE_STATUS, expiry: number): Promise<IAsyncRes<string[]>>

- Defined in imlib-next/API/subscribe.ts:18
订阅用户状态

此方法用于订阅一组用户的状态。当这些用户的状态发生变化时，将通过回调接口通知调用者。
since
5.9.8

Parameters
- userIds: string[]
  
  被订阅用户 ID 列表，一次最多订阅 200 个用户
- subscribeType: ONLINE_STATUS
  
  订阅类型
- expiry: number
  
  订阅有效期，单位为秒
Returns Promise<IAsyncRes<string[]>>
订阅错误为 26021 时返回被订阅达上限的用户 ID 列表

unSubscribeUserStatus

unSubscribeUserStatus(userIds: string[], subscribeType: ONLINE_STATUS): Promise<IAsyncRes<void>>

- Defined in imlib-next/API/subscribe.ts:57
取消订阅用户状态

此方法用于取消已经订阅的用户状态事件。
since
5.9.8

Parameters
- userIds: string[]
  
  被订阅用户 ID 列表，一次最多订阅 200 个用户
- subscribeType: ONLINE_STATUS
  
  订阅类型
Returns Promise<IAsyncRes<void>>

getSubscribeUserList

getSubscribeUserList(subscribeType: ONLINE_STATUS, pageSize: number, offset: number): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>

- Defined in imlib-next/API/subscribe.ts:93
查询当前的订阅用户列表

此方法用于获取当前所有订阅的事件的状态信息。（仅支持在线状态类型）
since
5.9.8

Parameters
- subscribeType: ONLINE_STATUS
- pageSize: number
  
  数量
- offset: number
  
  分页偏移量
Returns Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>

getSubscribeUserStatus

getSubscribeUserStatus(subscribeType: ONLINE_STATUS, userIds: string[]): Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>

- Defined in imlib-next/API/subscribe.ts:127
获取指定用户的状态

since
5.9.8

Parameters
- subscribeType: ONLINE_STATUS
- userIds: string[]
  
  被订阅用户 ID 列表
Returns Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>

createUploadTask

createUploadTask(uploadInfo: IUploadInfo): Promise<IAsyncRes<UploadTask>>

- Defined in imlib-next/API/upload.ts:47
创建文件上传任务

Parameters
- uploadInfo: IUploadInfo
Returns Promise<IAsyncRes<UploadTask>>

stopUploadTask

stopUploadTask(taskId: number): Promise<IAsyncRes<boolean>>

- Defined in imlib-next/API/upload.ts:70
停止文件上传任务

Parameters
- taskId: number
Returns Promise<IAsyncRes<boolean>>

upload

upload(uploadInfo: IUploadInfo): Promise<IAsyncRes<IUploadResult>>

- Defined in imlib-next/API/upload.ts:74
Parameters
- uploadInfo: IUploadInfo
Returns Promise<IAsyncRes<IUploadResult>>

getDownloadAuth

getDownloadAuth(url: string): Promise<IAsyncRes<{ deadline: number; token?: string; downloadAuthInfo?: IDownloadAuth }>>

- Defined in imlib-next/API/upload.ts:126
获取下载鉴权信息

description
通过文件 URL 地址获取下载鉴权信息，用于下载文件时的鉴权 token: 原 RCX 存储鉴权 token，优先使用 downloadAuthInfo: RCX 升级后，公有云私有化部署的下载鉴权信息

Parameters
- url: string
  
  文件 URL 地址
Returns Promise<IAsyncRes<{ deadline: number; token?: string; downloadAuthInfo?: IDownloadAuth }>>

Const ConnectType

ConnectType: { COMET: string; WEBSOCKET: string } = ...

deprecated: 从 5.6.0 版本开始，此定义失效

Type declaration

COMET: string
WEBSOCKET: string

Const MessageType

MessageType: { TEXT: string; VOICE: string; HQ_VOICE: string; IMAGE: string; GIF: string; RICH_CONTENT: string; LOCATION: string; FILE: string; SIGHT: string; COMBINE: string; COMBINE_V2: string; CHRM_KV_NOTIFY: string; LOG_COMMAND: string; EXPANSION_NOTIFY: string; REFERENCE: string; RECALL_MESSAGE_TYPE: string } = ...

Type declaration

TEXT: string
VOICE: string
HQ_VOICE: string
IMAGE: string
GIF: string
RICH_CONTENT: string
LOCATION: string
FILE: string
SIGHT: string
COMBINE: string
COMBINE_V2: string
CHRM_KV_NOTIFY: string
LOG_COMMAND: string
EXPANSION_NOTIFY: string
REFERENCE: string
RECALL_MESSAGE_TYPE: string

MentionedInfo

MentionedInfo: { type?: 1 | 2; userIdList?: string[] }

Type declaration

Optional type?: 1 | 2

@ 类型，其中 1 为 @ 所有人，2 为 @ 部分人
Optional userIdList?: string[]

被 @ 的用户 Id 列表，仅在 type 为 2 时有效

IInitOption

IInitOption: { appkey: string; logLevel?: LogLevel; logOutputLevel?: EnableLogL; logStdout?: any; navigators?: string[]; connectType?: "websocket" | "comet"; customCMP?: string[]; indexDBSwitch?: boolean; checkCA?: boolean; uploadDomain?: string; httpInMainProcess?: boolean; logExpireTime?: number; areaCode?: AreaCode; logServerUrl?: string }

Type declaration

appkey: string

应用 appkey 标识
Optional logLevel?: LogLevel

该配置已废弃，请使用 logOutputLevel 替代。

deprecated
修改 SDK 内部日志打印等级，默认为 LogLevel.WARN。
Optional logOutputLevel?: EnableLogL

修改内部日志打印等级，默认输出 LogL.WARN 及以上级别
logStdout?:function
- logStdout(logLevel: LogLevel, content: string): void
- - Defined in imlib-next/common/type.ts:25
  deprecated
  配置已废弃
  Parameters
  - logLevel: LogLevel
  - content: string
  Returns void
Optional navigators?: string[]

自定义导航地址，公有云用户不推荐修改
Optional connectType?: "websocket" | "comet"

连接方式，默认使用 'websocket'

deprecated
自 5.6.0 版本开始，不再支持 Comet 连接，该配置项失效。
Optional customCMP?: string[]

小程序平台专属配置
Optional indexDBSwitch?: boolean
deprecated
是否打开 IndexDB 存储, 默认为 true
Optional checkCA?: boolean
deprecated
已废弃，默认不再在 Electron 平台下校验导航服务的 CA 问题
Optional uploadDomain?: string

七牛上传文件地址域名（仅私有云 RCX 服务支持）
Optional httpInMainProcess?: boolean
开启后，SDK 内的 HTTP 请求将由 Electron 主进程内发送。
since
5.6.0

description
仅在 Electron 环境中搭配 @rongcloud/electron-renderer 与 @rongcloud/electron 包时有效。
- 当值为 true 时，HTTP 请求由 Electron 主进程内发送，不受浏览器安全沙箱策略限制。
- 当值为 false 时，保持使用 Chromium 的 XMLHttpRequest 发送 HTTP 协议请求，请求由渲染进程内发出，受浏览器安全沙箱策略限制。
defautl
false
Optional logExpireTime?: number

IndexDB 数据库内的日志有效期，单位为小时，有效值为 24 - 168，默认 IndexDB 内日志数据有效期 168 小时
Optional areaCode?: AreaCode

区域码

since
5.7.9
Optional logServerUrl?: string

日志上报服务地址

since
5.7.7

GetHistoryMessageOption

GetHistoryMessageOption: { timestamp?: number; count?: number; order?: 0 | 1 }

Type declaration

Optional timestamp?: number

获取此时间之前的消息，0 为从当前时间拉取
Optional count?: number

获取消息的数量，范围: 1-100 如果 SDK < 5.7.4，范围为 [1-20]；如果 SDK ≧ 5.7.4，范围为 [1-100]。默认值 20
Optional order?: 0 | 1
获取消息的排列顺序
- 0: 升序
- 1: 降序

GetHistoryMessageResult

GetHistoryMessageResult: { list: IAReceivedMessage[]; hasMore: boolean }

Type declaration

list: IAReceivedMessage[]
hasMore: boolean

EventListeners

EventListeners: { CONNECTING: any; CONNECTED: any; DISCONNECT: any; SUSPEND: any; MESSAGES: any; READ_RECEIPT_RECEIVED: any; MESSAGE_RECEIPT_REQUEST: any; MESSAGE_RECEIPT_RESPONSE: any; CONVERSATION: any; CHATROOM: any; EXPANSION: any; PULL_OFFLINE_MESSAGE_FINISHED: any; TAG: any; CONVERSATION_TAG: any; TYPING_STATUS: any; MESSAGE_BLOCKED: any; ULTRA_GROUP_ENABLE: any; OPERATE_STATUS: any; ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED: any; ULTRA_GROUP_MESSAGE_MODIFIED: any; ULTRA_GROUP_MESSAGE_RECALLED: any; ULTRA_GROUP_CHANNEL_TYPE_CHANGE: any; ULTRA_GROUP_CHANNEL_DELETE: any; ULTRA_GROUP_CHANNEL_USER_KICKED: any; USER_GROUP_STATUS: any; MESSAGE_READ_RECEIPT_V4: any; SUBSCRIBED_USER_STATUS_CHANGE: any; SUBSCRIBED_RELATION_CHANGE: any; SYNC_SUBSCRIBED_USER_STATUS_FINISHED: any }

Type declaration

CONNECTING:function
- CONNECTING(): void
- - Defined in imlib-next/core/message-bus.ts:25
  Returns void
CONNECTED:function
- CONNECTED(): void
- - Defined in imlib-next/core/message-bus.ts:26
  Returns void
DISCONNECT:function
- DISCONNECT(code: ErrorCode): void
- - Defined in imlib-next/core/message-bus.ts:27
  Parameters
  - code: ErrorCode
  Returns void
SUSPEND:function
- SUSPEND(code: ErrorCode): void
- - Defined in imlib-next/core/message-bus.ts:28
  Parameters
  - code: ErrorCode
  Returns void
MESSAGES:function
- MESSAGES(messages: IMessagesEvent): void
- - Defined in imlib-next/core/message-bus.ts:29
  Parameters
  - messages: IMessagesEvent
  Returns void
READ_RECEIPT_RECEIVED:function
- READ_RECEIPT_RECEIVED(event: IReadReceiptReceivedEvent): void
- - Defined in imlib-next/core/message-bus.ts:30
  Parameters
  - event: IReadReceiptReceivedEvent
  Returns void
MESSAGE_RECEIPT_REQUEST:function
- MESSAGE_RECEIPT_REQUEST(event: IMessageReceiptRequestEvent): void
- - Defined in imlib-next/core/message-bus.ts:31
  Parameters
  - event: IMessageReceiptRequestEvent
  Returns void
MESSAGE_RECEIPT_RESPONSE:function
- MESSAGE_RECEIPT_RESPONSE(event: IMessageReceiptResponseEvent): void
- - Defined in imlib-next/core/message-bus.ts:32
  Parameters
  - event: IMessageReceiptResponseEvent
  Returns void
CONVERSATION:function
- CONVERSATION(event: IConversationEvent): void
- - Defined in imlib-next/core/message-bus.ts:33
  Parameters
  - event: IConversationEvent
  Returns void
CHATROOM:function
- CHATROOM(event: IChatroomListenerData): void
- - Defined in imlib-next/core/message-bus.ts:34
  Parameters
  - event: IChatroomListenerData
  Returns void
EXPANSION:function
- EXPANSION(event: IExpansionListenerData): void
- - Defined in imlib-next/core/message-bus.ts:35
  Parameters
  - event: IExpansionListenerData
  Returns void
PULL_OFFLINE_MESSAGE_FINISHED:function
- PULL_OFFLINE_MESSAGE_FINISHED(): void
- - Defined in imlib-next/core/message-bus.ts:36
  Returns void
TAG:function
- TAG(): void
- - Defined in imlib-next/core/message-bus.ts:37
  Returns void
CONVERSATION_TAG:function
- CONVERSATION_TAG(): void
- - Defined in imlib-next/core/message-bus.ts:38
  Returns void
TYPING_STATUS:function
- TYPING_STATUS(event: ITypingStatusEvent): void
- - Defined in imlib-next/core/message-bus.ts:39
  Parameters
  - event: ITypingStatusEvent
  Returns void
MESSAGE_BLOCKED:function
- MESSAGE_BLOCKED(data: IBlockedMessageInfo): void
- - Defined in imlib-next/core/message-bus.ts:40
  Parameters
  - data: IBlockedMessageInfo
  Returns void
ULTRA_GROUP_ENABLE:function
- ULTRA_GROUP_ENABLE(list: IAReceivedConversation[]): void
- - Defined in imlib-next/core/message-bus.ts:41
  Parameters
  - list: IAReceivedConversation[]
  Returns void
OPERATE_STATUS:function
- OPERATE_STATUS(status: IOperateStatusNotify): void
- - Defined in imlib-next/core/message-bus.ts:42
  Parameters
  - status: IOperateStatusNotify
  Returns void
ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED:function
- ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED(list: IAReceivedMessage[]): void
- - Defined in imlib-next/core/message-bus.ts:43
  Parameters
  - list: IAReceivedMessage[]
  Returns void
ULTRA_GROUP_MESSAGE_MODIFIED:function
- ULTRA_GROUP_MESSAGE_MODIFIED(list: IAReceivedMessage[]): void
- - Defined in imlib-next/core/message-bus.ts:44
  Parameters
  - list: IAReceivedMessage[]
  Returns void
ULTRA_GROUP_MESSAGE_RECALLED:function
- ULTRA_GROUP_MESSAGE_RECALLED(list: IAReceivedMessage[]): void
- - Defined in imlib-next/core/message-bus.ts:45
  Parameters
  - list: IAReceivedMessage[]
  Returns void
ULTRA_GROUP_CHANNEL_TYPE_CHANGE:function
- ULTRA_GROUP_CHANNEL_TYPE_CHANGE(list: IUltraChannelChangeInfo[]): void
- - Defined in imlib-next/core/message-bus.ts:46
  Parameters
  - list: IUltraChannelChangeInfo[]
  Returns void
ULTRA_GROUP_CHANNEL_DELETE:function
- ULTRA_GROUP_CHANNEL_DELETE(list: IUltraChannelDeleteInfo[]): void
- - Defined in imlib-next/core/message-bus.ts:47
  Parameters
  - list: IUltraChannelDeleteInfo[]
  Returns void
ULTRA_GROUP_CHANNEL_USER_KICKED:function
- ULTRA_GROUP_CHANNEL_USER_KICKED(list: IUltraChannelUserKickedInfo[]): void
- - Defined in imlib-next/core/message-bus.ts:48
  Parameters
  - list: IUltraChannelUserKickedInfo[]
  Returns void
USER_GROUP_STATUS:function
- USER_GROUP_STATUS(list: IUserGroupStatusInfo): void
- - Defined in imlib-next/core/message-bus.ts:49
  Parameters
  - list: IUserGroupStatusInfo
  Returns void
MESSAGE_READ_RECEIPT_V4:function
- MESSAGE_READ_RECEIPT_V4(data: IReadReceiptData): void
- - Defined in imlib-next/core/message-bus.ts:58
  Parameters
  - data: IReadReceiptData
  Returns void
SUBSCRIBED_USER_STATUS_CHANGE:function
- SUBSCRIBED_USER_STATUS_CHANGE(data: ISubscribeUserStatusInfo[]): void
- - Defined in imlib-next/core/message-bus.ts:63
  Parameters
  - data: ISubscribeUserStatusInfo[]
  Returns void
SUBSCRIBED_RELATION_CHANGE:function
- SUBSCRIBED_RELATION_CHANGE(data: ISubscribeRelationInfo[]): void
- - Defined in imlib-next/core/message-bus.ts:64
  Parameters
  - data: ISubscribeRelationInfo[]
  Returns void
SYNC_SUBSCRIBED_USER_STATUS_FINISHED:function
- SYNC_SUBSCRIBED_USER_STATUS_FINISHED(): void
- - Defined in imlib-next/core/message-bus.ts:65
  Returns void

Index

基础

会话

消息

聊天室

超级群

会话未读数

标签

草稿

黑名单

Enum

Interface

其他

基础

connect

Parameters

token: string

Optional reconnectKickEnable: boolean

Returns Promise<IAsyncRes<{ userId: string }>>

disconnect

Parameters

Optional closeDB: boolean

Returns Promise<void>

addEventListener

Type Parameters

T extends Events

Parameters

eventType: T

listener: EventListeners[T]

Optional target: any

Returns void

onceEventListener

Type Parameters

T extends Events

Parameters

eventType: T

listener: EventListeners[T]

Optional target: any

Returns void

removeEventListener

Type Parameters

T extends Events

Parameters

eventType: T

listener: EventListeners[T]

Optional target: any

Returns void

removeEventListeners

Parameters

eventType: string

Returns void

clearEventListeners

Returns void

getConnectionStatus

Returns RCConnectionStatus

getServerTime

Returns number

getCurrentUserId

Returns string

getDeviceId

Returns string

installPlugin

Type Parameters

T

O

Parameters

plugin: IPluginGenerator<T, O>

options: O

Returns T | null

会话

getConversationList

Parameters

Optional options: { count?: number; startTime?: number; order?: 0 | 1 }

Optional count?: number

Optional startTime?: number

Optional order?: 0 | 1

Optional channelId: string

Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getConversation

Parameters