RongIMLib - v5.16.0

Index

会话

setConversationNotificationLevel

消息

超级群

订阅用户状态

subscribeUserStatus

Enum

其他

好友

refuseFriendApplication

会话

setConversationNotificationLevel

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

- Defined in packages/imlib-next/API/conversation.ts:428
设置会话免打扰
description
支持按照 NotificationLevel 类型进行免打扰级别设置，级别描述如下：
- -1: 全部消息通知（接收全部消息通知 -- 显示指定关闭免打扰功能）
- 0: 未设置（向上查询群或者APP级别设置）//存量数据中0表示未设置
- 1: 群聊超级群仅@消息通知（现在通知）单聊代表全部消息通知
- 2: @ 指定用户通知
- 3: @ 群用户组通知，通知用户组暂未实现，暂不暴露出去
- 4: @ 群全员通知
- 5: 消息通知被屏蔽，即不接收消息通知
since
5.3.0

example
设置会话免打扰示例：
```
const options = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId',
}
const notificationLevel = RongIMLib.NotificationLevel.NOT_MESSAGE_NOTIFICATION;
const res = await RongIMLib.setConversationNotificationLevel(options, notificationLevel);
console.info('设置会话免打扰结果：', res);
```
Parameters
- options: IConversationOption
  
  会话信息
- notificationLevel: NotificationLevel
  
  需要设置的免打扰级别，类型为 NotificationLevel
Returns Promise<IAsyncRes<void>>

消息

sendFileMessage

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

- Defined in packages/imlib-next/API/message.ts:300
发送文件消息
description
发送文件消息的快捷方式，等同于使用 new FileMessage() 创建消息体后调用 sendMessage() 方法，支持文件上传，上传成功后自动发送消息

example
发送文本消息示例：
```
const msgBody = { file }; // file 为待上传文件
const conversation = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId'
}
const sendRes = await RongIMLib.sendFileMessage(conversation, msgBody);
console.info('消息发送结果：', sendRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- msgBody: ISendBody
  
  消息体，其中 file 为待上传文件引用
- Optional hooks: IUploadHooks
  
  上传文件过程中的回调钩子，类型为 IUploadHooks 可选
- Optional sendOptions: IUploadMessageOption
  
  文件消息配置项，类型为 IUploadMessageOption 可选
Returns Promise<IAsyncRes<IAReceivedMessage>>
返回一个 IAsyncRes 类型 Promise，data 结构为 IAReceivedMessage 类型

sendImageMessage

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

- Defined in packages/imlib-next/API/message.ts:338
发送图片消息
description
发送图片消息的快捷方式，等同于使用 new ImageMessage() 创建消息体后调用 sendMessage() 方法，支持图片上传，上传成功后自动发送消息

example
发送图片消息示例：
```
const msgBody = { file }; // file 为待上传图片
const conversation = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId'
}
const sendRes = await RongIMLib.sendImageMessage(conversation, msgBody);
console.info('消息发送结果：', sendRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- msgBody: ISendBody
  
  消息体，其中 file 为待上传图片引用
- Optional hooks: IUploadHooks
  
  上传图片过程中的回调钩子，类型为 IUploadHooks 可选
- Optional sendOptions: IImageMessageOption
  
  图片消息配置项，类型为 IImageMessageOption 可选
Returns Promise<IAsyncRes<IAReceivedMessage>>
返回一个 IAsyncRes 类型 Promise，data 结构为 IAReceivedMessage 类型

sendGIFMessage

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

- Defined in packages/imlib-next/API/message.ts:375
发送 GIF 图片消息
description
发送 GIF 图片消息的快捷方式，等同于使用 new GIFMessage() 创建消息体后调用 sendMessage() 方法，支持 GIF 图片上传，上传成功后自动发送消息

example
发送 GIF 图片消息示例：
```
const msgBody = { file }; // file 为待上传 GIF 图片
const conversation = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId'
}
const sendRes = await RongIMLib.sendGIFMessage(conversation, msgBody);
console.info('消息发送结果：', sendRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- msgBody: ISendBody
  
  消息体，其中 file 为待上传 GIF 图片引用
- Optional hooks: IUploadHooks
  
  上传 GIF 图片过程中的回调钩子，类型为 IUploadHooks 可选
- Optional sendOptions: IUploadMessageOption
  
  GIF 图片消息配置项，类型为 {@link IGIFMessageOption} 可选
Returns Promise<IAsyncRes<IAReceivedMessage>>
返回一个 IAsyncRes 类型 Promise，data 结构为 IAReceivedMessage 类型

sendHQVoiceMessage

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

- Defined in packages/imlib-next/API/message.ts:415
发送高清语音消息
description
待发送的文件必须为 AAC 音频文件。发送高清语音消息的快捷方式，等同于使用 new HQVoiceMessage() 创建消息体后调用 sendMessage() 方法，支持高清语音上传，上传成功后自动发送消息

example
发送高清语音消息示例：
```
const msgBody = { file }; // file 为待上传高清语音
const conversation = {
conversationType: RongIMLib.ConversationType.PRIVATE,
targetId: 'targetId'
}
const sendRes = await RongIMLib.sendHQVoiceMessage(conversation, msgBody);
console.info('消息发送结果：', sendRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- msgBody: ISendBody
  
  消息体，其中 file 为待上传高清语音引用
- Optional hooks: IUploadHooks
  
  上传高清语音过程中的回调钩子，类型为 IUploadHooks 可选
- Optional sendOptions: IUploadMessageOption
  
  高清语音消息配置项，类型为 {@link ISendHQVoiceMessageOptions} 可选
Returns Promise<IAsyncRes<IAReceivedMessage>>
返回一个 IAsyncRes 类型 Promise，data 结构为 IAReceivedMessage 类型

sendSightMessage

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

- Defined in packages/imlib-next/API/message.ts:454
发送小视频消息
description
发送的小视频消息必须是 MP4 文件，且音频编码为 AAC，视频编码 H264，否则可能造成 iOS 或 Android 接收后不可播放问题。发送小视频消息的快捷方式，等同于使用 new SightMessage() 创建消息体后调用 sendMessage() 方法，支持小视频上传，上传成功后自动发送消息

example
发送小视频消息示例：
```
const msgBody = { file, duration: 10, thumbnail: 'base64' }; // file 为待上传小视频，duration 为小视频时长，thumbnail 为小视频封面 base64
const conversation = {
conversationType: RongIMLib.ConversationType.PRIVATE,
targetId: 'targetId'
}
const sendRes = await RongIMLib.sendSightMessage(conversation, msgBody);
console.info('消息发送结果：', sendRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- msgBody: ISendSightMessageOptions
  
  消息体，其中 file 为待上传小视频引用
- Optional hooks: IUploadHooks
  
  上传小视频过程中的回调钩子，类型为 IUploadHooks 可选
- Optional sendOptions: IUploadMessageOption
  
  小视频消息配置项，类型为 ISendSightMessageOptions 可选
Returns Promise<IAsyncRes<IAReceivedMessage>>
返回一个 IAsyncRes 类型 Promise，data 结构为 IAReceivedMessage 类型

sendSyncReadStatusMessage

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

- Defined in packages/imlib-next/API/message.ts:765
多端同步阅读状态
description
由于未读消息数存储在本地，服务器不存未读消息数量。当用户多端登录时，需要同步未读消息数以保证多端未读数一致

example
多端同步阅读状态示例：
```
const conversation = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId',
}
const timestamp = 1632728573423; // 阅读消息的 sendTime
const syncReadStatusRes = await RongIMLib.sendSyncReadStatusMessage(conversation, timestamp);
console.info('多端同步阅读状态：', syncReadStatusRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- timestamp: number
  
  需要同步消息阅读的时间戳，可以在消息体中通过消息的 sendTime 获取
Returns Promise<IAsyncRes<void>>

deleteMessages

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

- Defined in packages/imlib-next/API/message.ts:965
按消息 UId 删除消息
description
根据消息的 ID、时间戳和方向（发送或接收）从服务端删除指定单个会话中的一条或一组消息。
- 注意：
1. 删除消息仅会删除本端消息，不会删除对端消息。A 与 B 之间的消息，A 删除消息后，B 仍然可以看到消息。如 B 需要无法查看需要调用撤回消息 recallMessage接口。
2. 仅适用于 App Key 已开通单群聊消息云端存储的 App。
3. 服务端默认不会删除对应的离线消息补偿，如需彻底删除消息补偿，请提交工单，申请开通删除服务端历史消息时同时删除多端补偿的离线消息。
example
按消息 UId 删除消息示例：
```
const conversation = {
 conversationType: RongIMLib.ConversationType.PRIVATE,
 targetId: 'targetId',
};
const messages = [{
 messageUId: 'BS4O-P5AO-D1O6-9GPP', // 消息 UId
 sentTime: 1632728573423, // 消息发送时间
 messageDirection: RongIMLib.MessageDirection.SEND, // 消息方向
}];
const deleteRes = await RongIMLib.deleteMessages(conversation, messages);
console.info('删除消息结果：', deleteRes);
```
Parameters
- conversation: IConversationOption
  
  会话信息
- messages: { messageUId: string; sentTime: number; messageDirection: MessageDirection }[]
  
  消息列表
Returns Promise<IAsyncRes<void>>

updateMessageExpansion

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

- Defined in packages/imlib-next/API/message.ts:1125
更新（添加、替换）消息扩展属性
description
消息扩展功能可为消息增加基于 Key/Value 的状态标识。消息的扩展信息可在发送前、后设置或更新，可用于实现消息评论、礼物领取、订单状态变化等业务需求。
- 注意：
1. 单条消息单次最多可设置 20 个扩展信息 KV 对，总计不可超过 300 个扩展信息 KV 对。
2. 消息扩展（Key、Value 扩展信息）会被存储。如已开通历史消息云存储功能，从服务端获取的历史消息也会携带已设置的扩展信息。
3. 仅支持单聊、群聊会话类型，不支持聊天室类型。
4. 仅当发送消息时指定 canIncludeExpansion 值为 true，才可对消息进行拓展。
example
更新（添加、替换）消息扩展属性示例：
```
const expansion = { key1: 'value1' };
// message 为 IAReceivedMessage 类型消息体，此处不做具体示例，可在消息监听或者获取历史消息接口获取需要操作的 message
const updateRes = await RongIMLib.updateMessageExpansion(expansion, message);
console.info('更新消息扩展属性结果：', updateRes);
```
Parameters
- expansion: {}
  
  要更新的消息扩展信息键值对
  - [key: string]: any
- message: IAReceivedMessage
  
  要更新的原始消息体
Returns Promise<IAsyncRes<void>>

removeMessageExpansionForKey

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

删除扩展存储

description

删除消息扩展信息中指定的 Key

params

keys 需删除消息扩展的 keys

params

message 原始消息体

example

删除扩展存储示例：

const keys = ['key1'];
// message 为 IAReceivedMessage 类型消息体，此处不做具体示例，可在消息监听或者获取历史消息接口获取需要操作的 message
const removeRes = await RongIMLib.removeMessageExpansionForKey(keys, message);
console.info('删除扩展存储结果：', removeRes);

Parameters

keys: string[]
message: IAReceivedMessage

Returns Promise<IAsyncRes<void>>

registerMessageType

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

- Defined in packages/imlib-next/API/message.ts:1335
注册自定义消息
description
注册自定义消息，用于定义自定义消息的类型，会影响消息的发送和接收
- 注意：
1. 注册自定义消息代码必须在发送、接收该自定义消息之前
2. 推荐将所有注册自定义消息代码放在 init 方法之后, connect 方法之前
3. 注册的消息类型名, 必须多端一致, 否则消息无法互通
4. 请勿使用 RC: 开头的类型名，以免和 SDK 默认的消息名称冲突，自定义消息的消息类型名如和 SDK 默认的消息类型名相同以 SDK 默认的消息定义名为准
5. 需要再 connect 之前调用防止手消息行为异常
example
```
const messageType = 'CustomMessage';
const isPersited = true;
const isCounted = true;
const searchProps = ['content']; // 搜索字段
const isStatusMsg = false;
const CustomMessage = RongIMLib.registerMessageType(messageType, isPersited, isCounted, searchProps, isStatusMsg);
```
Type Parameters
- T
Parameters
- messageType: string
  
  消息类型
- isPersited: boolean
  
  是否存储
- isCounted: boolean
  
  是否计数
- Optional searchProps: string[]
  
  可搜索的属性，web 端无需设置，搜索字段值设置为数字时取值范围为 (-Math.pow(2, 64), Math.pow(2, 64)) 且为整数
- Optional isStatusMessage: boolean
  
  是否状态消息，状态消息不计数，不存储，接收方在线时才能收到
Returns (new (content: T) => BaseMessage<T>)
返回一个 BaseMessage 类型的构造函数
- - new (content: T): BaseMessage<T>
  - Parameters
    - content: T
    Returns BaseMessage<T>

超级群

getUltraGroupMessageListByMessageUId

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

- Defined in packages/imlib-next/API/ultra-group.ts:108
从服务端获取特定批量消息
description
根据消息的 Uid 从服务端获取特定批量消息

since
5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。

example
从服务端获取特定批量消息示例：
```
const options = {
conversationType: RongIMLib.ConversationType.ULTRA_GROUP,
targetId: 'targetId',
channelId: 'channelId',
};
// sendTime 为消息的发送时间，此处示例为假数据
const messages = [{ messageUId: 'messageUId1', sendTime: 1626864000000, }];
const res = await RongIMLib.getUltraGroupMessageListByMessageUId(options, messages);
console.log('从服务端获取特定批量消息结果：', res);
```
Parameters
- options: IConversationOption
  
  获取消息参数，包含会话类型、目标 Id、频道 Id，类型为 IConversationOption
- messages: IMessageDesc[]
  
  消息列表，包含消息的 Uid，类型为 IMessageDesc 数组
Returns Promise<IAsyncRes<{}>>
返回一个 IAsyncRes 类型 Promise，data 为消息列表，code 接口返回状态码从 SDK 版本 @since 5.7.0 开始，该接口的返回数据类型由 IReceivedMessage 变更为 IAReceivedMessage

updateExpansionForUltraGroupMessage

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

- Defined in packages/imlib-next/API/ultra-group.ts:176
设置、更新消息扩展信息
description
设置、更新消息扩展信息，用于超级群消息扩展信息的设置、更新，消息扩展信息
- 适用场景：原始消息增加状态标识的需求，都可使用消息扩展
1. 消息评论需求，可通过设置原始消息扩展信息的方式添加评论信息。
2. 礼物领取、订单状态变化需求，通过此功能改变消息显示状态。例如：向用户发送礼物，默认为未领取状态，用户点击后可设置消息扩展为已领取状态
- 注意：
1. 每次设置消息扩展将会产生内置通知消息，频繁设置扩展会产生大量消息
2. 仅当发送消息时指定 canIncludeExpansion 值为 true，才可对消息进行扩展
since
5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。

example
设置、更新消息扩展信息示例：
```
const expansion = { key1: 'value1' };
const message = {} // 需要设置的消息，类型为 IAReceivedMessage
const res = await RongIMLib.updateExpansionForUltraGroupMessage(expansion, message);
console.log('设置、更新消息扩展信息结果：', res);
```
Parameters
- expansion: {}
  
  消息扩展信息，类型是 Object。Key 支持大小写英文字母、数字、特殊字符+ = - _ 的组合方式，不支持汉字。最大 32 个字符。
  （SDK < 5.3.0）Value 最大 64 个字符
  （SDK ≧ 5.3.0）Value 最大 4096 个字符
  - [key: string]: any
- message: IAReceivedMessage
  
  接收到的消息，类型是 IAReceivedMessage
Returns Promise<IAsyncRes<void>>
返回一个 IAsyncRes 类型 Promise，code 接口返回状态码

removeExpansionForUltraGroupMessage

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

- Defined in packages/imlib-next/API/ultra-group.ts:230
删除消息扩展
description
删除消息扩展，用于超级群消息扩展信息的删除，消息扩展信息

since
5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。

example
删除消息扩展示例：
```
const expansion = ['key1'];
// message 需要删除扩展的消息，类型为 IAReceivedMessage，此处示例伪代码
const res = await RongIMLib.removeExpansionForUltraGroupMessage(expansion, message);
console.log('删除消息扩展结果：', res);
```
Parameters
- expansion: string[]
  
  消息扩展信息的 key 数组，类型是 Array。Key 支持大小写英文字母、数字、特殊字符+ = - _ 的组合方式，不支持汉字。最大 32 个字符
- message: IAReceivedMessage
  
  接收到的消息，类型是 IAReceivedMessage
Returns Promise<IAsyncRes<void>>
返回一个 IAsyncRes 类型 Promise，code 接口返回状态码

removeAllExpansionForUltraGroupMessage

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

- Defined in packages/imlib-next/API/ultra-group.ts:281
删除指定消息上的所有扩展
description
删除指定消息上的所有扩展，用于超级群消息扩展信息的删除，消息扩展信息

since
5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。

example
删除指定消息上的所有扩展示例：
```
// message 需要删除扩展的消息，类型为 IAReceivedMessage，此处示例伪代码
const res = await RongIMLib.removeAllExpansionForUltraGroupMessage(message);
console.log('删除指定消息上的所有扩展结果：', res);
```
Parameters
- message: IAReceivedMessage
  
  接收到的消息，类型是 IAReceivedMessage
Returns Promise<IAsyncRes<void>>
返回一个 IAsyncRes 类型 Promise，code 接口返回状态码

modifyMessage

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

- Defined in packages/imlib-next/API/ultra-group.ts:333
修改消息
description
用户在成功发送超级群消息后，可以主动修改已发送消息的消息内容消息被修改后，IAReceivedMessage 对象的 isModifyMessage 属性会被更新为 true
- 注意：
1. 消息类型无法修改。如果改前为文本消息，则传入的新消息内容必须为 ITextMessageBody 类型
2. 无法修改他人发送的消息。
since
5.2.0 仅 Web 端 IMLib 支持超级群。Electron 解决方案暂不适用于超级群业务。

example
修改消息示例：
```
const content = { text: '修改后的消息内容' };
// message 需要修改的消息，类型为 IAReceivedMessage，此处示例伪代码
const res = await RongIMLib.modifyMessage(content, message);
console.log('修改消息结果：', res);
```
Parameters
- content: {}
  
  修改后的消息内容，大小不能超过 128k
  - [key: string]: any
- message: IAReceivedMessage
  
  需要修改的消息，类型是 IAReceivedMessage
Returns Promise<IAsyncRes<void>>
返回一个 IAsyncRes 类型 Promise，code 接口返回状态码

订阅用户状态

subscribeUserStatus

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

- Defined in packages/imlib-next/API/subscribe.ts:32
订阅用户状态
description
此方法用于订阅一组用户的状态。当这些用户的状态发生变化时，将通过回调接口通知调用者注意：
1. 一次订阅用户的上限为 200 个, 订阅的用户数最多为 1000 个，一个用户最多可以被 5000 个用户订阅
2. 订阅用户在线状态能力需要开通服务，开通路径： IM 服务 > IM 服务管理 > 客户端用户在线状态订阅
since
5.9.8

example
订阅用户状态示例：
```
const userIds = ['user1', 'user2'];
const subscribeType = RongIMLib.SubscribeType.ONLINE_STATUS;
// 设置订阅时间，取值范围为[60,2592000]（单位:秒）。
const expiry = 60;
const res = await RongIMLib.subscribeUserStatus(userIds, subscribeType, expiry);
console.log('订阅用户状态结果：', res);
```
Parameters
- userIds: string[]
  
  被订阅用户 ID 列表，一次最多订阅 200 个用户
- subscribeType: SubscribeType
  
  订阅类型
- expiry: number
  
  订阅有效期，取值范围为[60,2592000]（单位:秒）
Returns Promise<IAsyncRes<string[]>>
返回一个 IAsyncRes 类型 Promise，订阅错误为 26021 时返回被订阅达上限（用户最多可以被 5000 个用户订阅）的用户 ID 列表

其他

IChatroomRejoinedInfo

IChatroomRejoinedInfo: IChatroomRejoinedFailed | IChatroomRejoinedSuccessed

IProcessCode

IProcessCode: { processCode: ErrorCode }

Type declaration

processCode: ErrorCode

IAsyncRes

IAsyncRes<T>: Pick<RCResult<T>, "code" | "data"> & { msg?: string }

Type Parameters

T = void

IPromiseResult

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

Type Parameters

T = void

IErrorKeys

IErrorKeys: { errorKeys?: string[] }

Type declaration

Optional errorKeys?: string[]

IUpdateMyProfileFail

IUpdateMyProfileFail: IErrorKeys & { errorKey: string }

EnableLogL

EnableLogL: DEBUG | INFO | WARN | ERROR

IEventListener

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

Type declaration

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

IRemoveChatRoomEntries

IRemoveChatRoomEntries: IRemoveChatroomEntries

IChatRoomEntry

IChatRoomEntry: IChatroomEntry

IChatRoomEntries

IChatRoomEntries: IChatroomEntries

IRemoveChatRoomEntry

IRemoveChatRoomEntry: IRemoveChatroomEntry

IStreamMessageResponseChunkData

IStreamMessageResponseChunkData: { content: string; fullContent: string }

Type declaration

content: string
fullContent: string

addToBlacklist

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

- Defined in packages/imlib-next/API/blackList.ts:10
Parameters
- userId: string
Returns Promise<IAsyncRes<void>>

removeFromBlacklist

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

- Defined in packages/imlib-next/API/blackList.ts:24
Parameters
- userId: string
Returns Promise<IAsyncRes<void>>

getBlacklist

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

- Defined in packages/imlib-next/API/blackList.ts:38
Returns Promise<IAsyncRes<string[]>>

getBlacklistStatus

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

- Defined in packages/imlib-next/API/blackList.ts:57
Parameters
- userId: string
Returns Promise<IAsyncRes<boolean>>

joinChatRoom

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

- Defined in packages/imlib-next/API/chatroom.ts:15
Parameters
- targetId: string
- options: { count: number; extra?: string }
  - count: number
  - Optional extra?: string
Returns Promise<IAsyncRes<void>>

joinExistChatRoom

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

- Defined in packages/imlib-next/API/chatroom.ts:44
Parameters
- targetId: string
- options: { count: number; extra?: string }
  - count: number
  - Optional extra?: string
Returns Promise<IAsyncRes<IChatroomJoinResponse>>

quitChatRoom

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

- Defined in packages/imlib-next/API/chatroom.ts:74
Parameters
- targetId: string
Returns Promise<IAsyncRes<void>>

getChatRoomInfo

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

- Defined in packages/imlib-next/API/chatroom.ts:94
Parameters
- targetId: string
- Optional options: { count?: number; order?: 0 | 1 | 2 }
  - Optional count?: number
  - Optional order?: 0 | 1 | 2
Returns Promise<IAsyncRes<IChatroomInfo>>

setChatRoomEntry

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

- Defined in packages/imlib-next/API/chatroom.ts:124
Parameters
- targetId: string
- options: IChatroomEntry
Returns Promise<IAsyncRes<void>>

setChatRoomEntries

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

- Defined in packages/imlib-next/API/chatroom.ts:158
Parameters
- targetId: string
- options: IChatroomEntries
Returns Promise<IAsyncRes<void>>

forceSetChatRoomEntry

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

- Defined in packages/imlib-next/API/chatroom.ts:200
Parameters
- targetId: string
- options: IChatroomEntry
Returns Promise<IAsyncRes<void>>

removeChatRoomEntry

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

- Defined in packages/imlib-next/API/chatroom.ts:234
Parameters
- targetId: string
- options: IRemoveChatroomEntry
Returns Promise<IAsyncRes<void>>

removeChatRoomEntries

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

- Defined in packages/imlib-next/API/chatroom.ts:264
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 packages/imlib-next/API/chatroom.ts:307
Parameters
- targetId: string
- options: IRemoveChatroomEntry
Returns Promise<IAsyncRes<void>>

getChatRoomEntry

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

- Defined in packages/imlib-next/API/chatroom.ts:340
Parameters
- targetId: string
- key: string
Returns Promise<IAsyncRes<string | number | boolean>>

getAllChatRoomEntries

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

- Defined in packages/imlib-next/API/chatroom.ts:362
Parameters
- targetId: string
Returns Promise<IAsyncRes<{}>>

getChatroomHistoryMessages

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

- Defined in packages/imlib-next/API/chatroom.ts:382
Parameters
- targetId: string
- options: GetHistoryMessageOption
Returns Promise<IAsyncRes<GetHistoryMessageResult>>

bindRTCRoomForChatroom

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

- Defined in packages/imlib-next/API/chatroom.ts:439
Parameters
- option: IRTCRoomBindOption
Returns Promise<IAsyncRes<void>>

connect

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

- Defined in packages/imlib-next/API/connect.ts:7
Parameters
- token: string
- Optional reconnectKickEnable: boolean
Returns Promise<IAsyncRes<{ userId: string }>>

disconnect

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

- Defined in packages/imlib-next/API/connect.ts:27
Parameters
- Optional closeDB: boolean
Returns Promise<void>

getConversationList

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

- Defined in packages/imlib-next/API/conversation.ts:17
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

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

- Defined in packages/imlib-next/API/conversation.ts:54
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<IAReceivedConversation | null | undefined>>

removeConversation

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

- Defined in packages/imlib-next/API/conversation.ts:81
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

batchRemoveConversation

batchRemoveConversation(conversations: IConversationOption[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/conversation.ts:105
Parameters
- conversations: IConversationOption[]
Returns Promise<IAsyncRes<void>>

getTextMessageDraft

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

- Defined in packages/imlib-next/API/conversation.ts:141
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<string>>

saveTextMessageDraft

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

- Defined in packages/imlib-next/API/conversation.ts:165
Parameters
- options: IConversationOption
- draft: string
Returns Promise<IAsyncRes<void>>

clearTextMessageDraft

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

- Defined in packages/imlib-next/API/conversation.ts:197
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

getTotalUnreadCount

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

- Defined in packages/imlib-next/API/conversation.ts:221
Parameters
- Optional includeMuted: boolean
- Optional conversationTypes: ConversationType[]
Returns Promise<IAsyncRes<number>>

getTotalUnreadCountByLevels

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

- Defined in packages/imlib-next/API/conversation.ts:249
Parameters
- conversationTypes: ConversationType[]
- levels: NotificationLevel[]
Returns Promise<IAsyncRes<number>>

getTotalUnreadMentionedCountByLevels

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

- Defined in packages/imlib-next/API/conversation.ts:285
Parameters
- conversationTypes: ConversationType[]
- levels: NotificationLevel[]
Returns Promise<IAsyncRes<number>>

getUnreadCount

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

- Defined in packages/imlib-next/API/conversation.ts:321
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<number>>

clearMessagesUnreadStatus

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

- Defined in packages/imlib-next/API/conversation.ts:345
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

clearAllMessagesUnreadStatus

clearAllMessagesUnreadStatus(): Promise<IAsyncRes<ErrorCode>>

- Defined in packages/imlib-next/API/conversation.ts:371
Returns Promise<IAsyncRes<ErrorCode>>

batchSetConversationNotificationLevel

batchSetConversationNotificationLevel(conversations: IConversationOption[], notificationLevel: NotificationLevel): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/conversation.ts:452
Parameters
- conversations: IConversationOption[]
- notificationLevel: NotificationLevel
Returns Promise<IAsyncRes<void>>

setConversationNotificationStatus

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

- Defined in packages/imlib-next/API/conversation.ts:516
Parameters
- options: IConversationOption
- notificationStatus: NotificationStatus
Returns Promise<IAsyncRes<void>>

getConversationNotificationLevel

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

- Defined in packages/imlib-next/API/conversation.ts:541
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<NotificationLevel | undefined>>

getConversationNotificationStatus

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

- Defined in packages/imlib-next/API/conversation.ts:567
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<NotificationStatus | undefined>>

getBlockedConversationList

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

- Defined in packages/imlib-next/API/conversation.ts:592
Returns Promise<IAsyncRes<IBaseConversationInfo[]>>

setConversationTypeNotificationLevel

setConversationTypeNotificationLevel(conversationType: ConversationType, level: NotificationLevel): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/conversation.ts:595
Parameters
- conversationType: ConversationType
- level: NotificationLevel
Returns Promise<IAsyncRes<void>>

getConversationTypeNotificationLevel

getConversationTypeNotificationLevel(conversationType: ConversationType): Promise<IAsyncRes<NotificationLevel>>

- Defined in packages/imlib-next/API/conversation.ts:626
Parameters
- conversationType: ConversationType
Returns Promise<IAsyncRes<NotificationLevel>>

setConversationToTop

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

- Defined in packages/imlib-next/API/conversation.ts:654
Parameters
- options: IConversationOption
- isTop: boolean = true
- isUpdateTime: boolean = true
Returns Promise<IAsyncRes<void>>

batchSetConversationToTop

batchSetConversationToTop(conversations: IConversationOption[], isTop: boolean, isCreateConversation?: boolean): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/conversation.ts:689
Parameters
- conversations: IConversationOption[]
- isTop: boolean
- Optional isCreateConversation: boolean
Returns Promise<IAsyncRes<void>>

getTopConversationList

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

- Defined in packages/imlib-next/API/conversation.ts:755
Parameters
- Optional conversationTypes: ConversationType[]
- Optional channelId: string
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getUnreadConversationList

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

- Defined in packages/imlib-next/API/conversation.ts:790
Parameters
- Optional conversationTypes: ConversationType[]
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getUnreadMentionedCount

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

- Defined in packages/imlib-next/API/conversation.ts:830
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<number>>

getAllUnreadMentionedCount

getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>

- Defined in packages/imlib-next/API/conversation.ts:854
Returns Promise<IAsyncRes<number>>

getAllConversationState

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

- Defined in packages/imlib-next/API/conversation.ts:867
Returns Promise<IAsyncRes<IConversationState[]>>

getRealtimeConversations

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

- Defined in packages/imlib-next/API/conversation.ts:880
Parameters
- Optional options: { count?: number; startTime?: number; order?: 0 | 1 }
  - Optional count?: number
  - Optional startTime?: number
  - Optional order?: 0 | 1
Returns Promise<IAsyncRes<IAReceivedConversation[]>>

getRealtimeConTotalUnreadCount

getRealtimeConTotalUnreadCount(): Promise<IAsyncRes<number>>

- Defined in packages/imlib-next/API/conversation.ts:918
Returns Promise<IAsyncRes<number>>

clearRealtimeConUnreadCount

clearRealtimeConUnreadCount(conversation: IConversationIdentifier): Promise<IAsyncRes>

- Defined in packages/imlib-next/API/conversation.ts:939
Parameters
- conversation: IConversationIdentifier
Returns Promise<IAsyncRes>

removeRealtimeConversations

removeRealtimeConversations(conversations: IConversationIdentifier[]): Promise<IAsyncRes>

- Defined in packages/imlib-next/API/conversation.ts:961
Parameters
- conversations: IConversationIdentifier[]
Returns Promise<IAsyncRes>

getRealtimeConUnreadCounts

getRealtimeConUnreadCounts(conversations: IConversationIdentifier[]): Promise<IAsyncRes<IConversationUnreadCount[]>>

- Defined in packages/imlib-next/API/conversation.ts:987
Parameters
- conversations: IConversationIdentifier[]
Returns Promise<IAsyncRes<IConversationUnreadCount[]>>

addEventListener

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

- Defined in packages/imlib-next/API/events.ts:4
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 packages/imlib-next/API/events.ts:7
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 packages/imlib-next/API/events.ts:10
Type Parameters
- T extends Events
Parameters
- eventType: T
- listener: EventListeners[T]
- Optional target: any
Returns void

removeEventListeners

removeEventListeners(eventType: string): void

- Defined in packages/imlib-next/API/events.ts:13
Parameters
- eventType: string
Returns void

clearEventListeners

clearEventListeners(): void

- Defined in packages/imlib-next/API/events.ts:16
Returns void

addFriend

addFriend(userId: string, directionType: BOTH, extra?: string): Promise<IAsyncRes<IProcessCode>>

- Defined in packages/imlib-next/API/friend.ts:13
Parameters
- userId: string
- directionType: BOTH
- Optional extra: string
Returns Promise<IAsyncRes<IProcessCode>>

deleteFriends

deleteFriends(userIds: string[], directionType: BOTH): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/friend.ts:40
Parameters
- userIds: string[]
- directionType: BOTH
Returns Promise<IAsyncRes<void>>

acceptFriendApplication

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

- Defined in packages/imlib-next/API/friend.ts:65
Parameters
- userId: string
Returns Promise<IAsyncRes<void>>

setFriendInfo

setFriendInfo(userId: string, remark?: string, extProfile?: {}): Promise<IAsyncRes<IErrorKeys>>

- Defined in packages/imlib-next/API/friend.ts:118
Parameters
- userId: string
- remark: string = ''
- extProfile: {} = {}
  - [key: string]: string
Returns Promise<IAsyncRes<IErrorKeys>>

checkFriends

checkFriends(userIds: string[], directionType: BOTH): Promise<IAsyncRes<IFriendRelationInfo[]>>

- Defined in packages/imlib-next/API/friend.ts:165
Parameters
- userIds: string[]
- directionType: BOTH
Returns Promise<IAsyncRes<IFriendRelationInfo[]>>

getFriends

getFriends(directionType: BOTH, option?: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>

- Defined in packages/imlib-next/API/friend.ts:196
Parameters
- directionType: BOTH
- option: IPagingQueryOption = ...
Returns Promise<IAsyncRes<IPagingQueryResult<IFriendInfo>>>

getFriendApplications

getFriendApplications(option?: IPagingQueryOption, types?: FriendApplicationType[], status?: FriendApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>

- Defined in packages/imlib-next/API/friend.ts:244
Parameters
- option: IPagingQueryOption = ...
- Optional types: FriendApplicationType[]
- Optional status: FriendApplicationStatus[]
Returns Promise<IAsyncRes<IPagingQueryResult<IFriendApplicationInfo>>>

getFriendsInfo

getFriendsInfo(userIds: string[]): Promise<IAsyncRes<IFriendInfo[]>>

- Defined in packages/imlib-next/API/friend.ts:341
Parameters
- userIds: string[]
Returns Promise<IAsyncRes<IFriendInfo[]>>

searchFriendsInfo

searchFriendsInfo(name: string): Promise<IAsyncRes<IFriendInfo[]>>

- Defined in packages/imlib-next/API/friend.ts:364
Parameters
- name: string
Returns Promise<IAsyncRes<IFriendInfo[]>>

setFriendAddPermission

setFriendAddPermission(permission: FriendAddPermission): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/friend.ts:385
Parameters
- permission: FriendAddPermission
Returns Promise<IAsyncRes<void>>

getFriendAddPermission

getFriendAddPermission(): Promise<IAsyncRes<FriendAddPermission>>

- Defined in packages/imlib-next/API/friend.ts:407
Returns Promise<IAsyncRes<FriendAddPermission>>

createGroup

createGroup(groupInfo: IGroupInfoOption, inviteeUserIds?: string[]): Promise<IAsyncRes<ICreateGroupFail>>

- Defined in packages/imlib-next/API/group.ts:44
Parameters
- groupInfo: IGroupInfoOption
- Optional inviteeUserIds: string[]
Returns Promise<IAsyncRes<ICreateGroupFail>>

updateGroupInfo

updateGroupInfo(groupInfo: IGroupInfoOption): Promise<IAsyncRes<IErrorKeys>>

- Defined in packages/imlib-next/API/group.ts:166
Parameters
- groupInfo: IGroupInfoOption
Returns Promise<IAsyncRes<IErrorKeys>>

getGroupsInfo

getGroupsInfo(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>

- Defined in packages/imlib-next/API/group.ts:277
Parameters
- groupIds: string[]
Returns Promise<IAsyncRes<IGroupInfo[]>>

kickGroupMembers

kickGroupMembers(groupId: string, userIds: string[], config?: IQuitGroupConfig): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:301
Parameters
- groupId: string
- userIds: string[]
- config: IQuitGroupConfig = ...
Returns Promise<IAsyncRes<void>>

quitGroup

quitGroup(groupId: string, config?: IQuitGroupConfig): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:333
Parameters
- groupId: string
- config: IQuitGroupConfig = ...
Returns Promise<IAsyncRes<void>>

dismissGroup

dismissGroup(groupId: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:355
Parameters
- groupId: string
Returns Promise<IAsyncRes<void>>

transferGroupOwner

transferGroupOwner(groupId: string, newOwnerId: string, quitGroup?: boolean, config?: IQuitGroupConfig): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:372
Parameters
- groupId: string
- newOwnerId: string
- quitGroup: boolean = false
- config: IQuitGroupConfig = ...
Returns Promise<IAsyncRes<void>>

addGroupManagers

addGroupManagers(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:402
Parameters
- groupId: string
- userIds: string[]
Returns Promise<IAsyncRes<void>>

removeGroupManagers

removeGroupManagers(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:426
Parameters
- groupId: string
- userIds: string[]
Returns Promise<IAsyncRes<void>>

getGroupMembersByRole

getGroupMembersByRole(groupId: string, role: GroupMemberRole, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>

- Defined in packages/imlib-next/API/group.ts:449
Parameters
- groupId: string
- role: GroupMemberRole
- option: IPagingQueryOption
Returns Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>

getGroupMembers

getGroupMembers(groupId: string, userIds: string[]): Promise<IAsyncRes<IGroupMemberInfo[]>>

- Defined in packages/imlib-next/API/group.ts:503
Parameters
- groupId: string
- userIds: string[]
Returns Promise<IAsyncRes<IGroupMemberInfo[]>>

setGroupMemberInfo

setGroupMemberInfo(groupId: string, userId: string, nickname: string, extra?: string): Promise<IAsyncRes<IErrorKeys>>

- Defined in packages/imlib-next/API/group.ts:529
Parameters
- groupId: string
- userId: string
- nickname: string
- Optional extra: string
Returns Promise<IAsyncRes<IErrorKeys>>

searchGroupMembers

searchGroupMembers(groupId: string, name: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>

- Defined in packages/imlib-next/API/group.ts:566
Parameters
- groupId: string
- name: string
- option: IPagingQueryOption
Returns Promise<IAsyncRes<IPagingQueryResult<IGroupMemberInfo>>>

joinGroup

joinGroup(groupId: string): Promise<IAsyncRes<IProcessCode>>

- Defined in packages/imlib-next/API/group.ts:620
Parameters
- groupId: string
Returns Promise<IAsyncRes<IProcessCode>>

inviteUsersToGroup

inviteUsersToGroup(groupId: string, userIds: string[]): Promise<IAsyncRes<IProcessCode>>

- Defined in packages/imlib-next/API/group.ts:640
Parameters
- groupId: string
- userIds: string[]
Returns Promise<IAsyncRes<IProcessCode>>

acceptGroupInvite

acceptGroupInvite(groupId: string, inviterId: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:670
Parameters
- groupId: string
- inviterId: string
Returns Promise<IAsyncRes<void>>

refuseGroupInvite

refuseGroupInvite(groupId: string, inviterId: string, reason?: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:689
Parameters
- groupId: string
- inviterId: string
- Optional reason: string
Returns Promise<IAsyncRes<void>>

acceptGroupApplication

acceptGroupApplication(groupId: string, applicantId: string, inviterId?: string): Promise<IAsyncRes<IProcessCode>>

- Defined in packages/imlib-next/API/group.ts:714
Parameters
- groupId: string
- applicantId: string
- Optional inviterId: string
Returns Promise<IAsyncRes<IProcessCode>>

refuseGroupApplication

refuseGroupApplication(groupId: string, applicantId: string, inviterId?: string, reason?: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:742
Parameters
- groupId: string
- applicantId: string
- Optional inviterId: string
- Optional reason: string
Returns Promise<IAsyncRes<void>>

getGroupApplications

getGroupApplications(option: IPagingQueryOption, directions?: GroupApplicationDirection[], status?: GroupApplicationStatus[]): Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>

- Defined in packages/imlib-next/API/group.ts:769
Parameters
- option: IPagingQueryOption
- Optional directions: GroupApplicationDirection[]
- Optional status: GroupApplicationStatus[]
Returns Promise<IAsyncRes<IPagingQueryResult<IGroupApplicationInfo>>>

getJoinedGroupsByRole

getJoinedGroupsByRole(option: IPagingQueryOption, role: GroupMemberRole): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>

- Defined in packages/imlib-next/API/group.ts:824
Parameters
- option: IPagingQueryOption
- role: GroupMemberRole
Returns Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>

searchJoinedGroups

searchJoinedGroups(groupName: string, option: IPagingQueryOption): Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>

- Defined in packages/imlib-next/API/group.ts:874
Parameters
- groupName: string
- option: IPagingQueryOption
Returns Promise<IAsyncRes<IPagingQueryResult<IGroupInfo>>>

getJoinedGroups

getJoinedGroups(groupIds: string[]): Promise<IAsyncRes<IGroupInfo[]>>

- Defined in packages/imlib-next/API/group.ts:925
Parameters
- groupIds: string[]
Returns Promise<IAsyncRes<IGroupInfo[]>>

setGroupRemark

setGroupRemark(groupId: string, remark: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:949
Parameters
- groupId: string
- remark: string
Returns Promise<IAsyncRes<void>>

addGroupFollows

addGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:974
Parameters
- groupId: string
- userIds: string[]
Returns Promise<IAsyncRes<void>>

removeGroupFollows

removeGroupFollows(groupId: string, userIds: string[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/group.ts:997
Parameters
- groupId: string
- userIds: string[]
Returns Promise<IAsyncRes<void>>

getGroupFollows

getGroupFollows(groupId: string): Promise<IAsyncRes<IFollowsInfo[]>>

- Defined in packages/imlib-next/API/group.ts:1020
Parameters
- groupId: string
Returns Promise<IAsyncRes<IFollowsInfo[]>>

init

init(options: IInitOption): void

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

destroy

destroy(): Promise<void>

- Defined in packages/imlib-next/API/init.ts:12
Returns Promise<void>

getConnectionStatus

getConnectionStatus(): RCConnectionStatus

- Defined in packages/imlib-next/API/init.ts:17
Returns RCConnectionStatus

getServerTime

getServerTime(): number

- Defined in packages/imlib-next/API/init.ts:20
Returns number

getCurrentUserId

getCurrentUserId(): string

- Defined in packages/imlib-next/API/init.ts:23
Returns string

__addSDKVersion

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

- Defined in packages/imlib-next/API/init.ts:26
Parameters
- name: string
- version: string
Returns void

getDeviceId

getDeviceId(): string

- Defined in packages/imlib-next/API/init.ts:29
Returns string

installPlugin

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

- Defined in packages/imlib-next/API/install-plugin.ts:3
Type Parameters
- T
- O
Parameters
- plugin: IPluginGenerator<T, O>
- options: O
Returns T | null

getMessage

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

- Defined in packages/imlib-next/API/message.ts:34
Parameters
- messageId: string | number
Returns Promise<RCResult<IAReceivedMessage>>

sendMessage

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

- Defined in packages/imlib-next/API/message.ts:35
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 packages/imlib-next/API/message.ts:195
Parameters
- conversation: IConversationOption
- messageBody: ITextMessageBody
- Optional options: ISendMessageOptions
Returns Promise<IAsyncRes<IAReceivedMessage>>

ISendBody

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

ISendFileMessageOptions

ISendFileMessageOptions: ISendBody

ISendImageMessageOptions

ISendImageMessageOptions: ISendBody

ISendSightMessageOptions

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

getHistoryMessages

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

- Defined in packages/imlib-next/API/message.ts:491
Parameters
- conversation: IConversationOption
- Optional options: GetHistoryMessageOption
Returns Promise<IAsyncRes<GetHistoryMessageResult>>

getRemoteHistoryMessages

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

- Defined in packages/imlib-next/API/message.ts:556
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 packages/imlib-next/API/message.ts:612
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 packages/imlib-next/API/message.ts:641
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 packages/imlib-next/API/message.ts:669
Parameters
- targetId: string
- messageUIds: string[]
- Optional channelId: string
Returns Promise<IAsyncRes<void>>

sendReadReceiptResponseV2

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

- Defined in packages/imlib-next/API/message.ts:705
Parameters
- targetId: string
- Optional messageList: {}
  - [senderUserId: string]: string[]
- Optional channelId: string
Returns Promise<IAsyncRes<void>>

sendReadReceiptMessageV4

sendReadReceiptMessageV4(conversation: IConversationOption, endMsgUId: string, startMsgUId?: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/message.ts:807
Parameters
- conversation: IConversationOption
- endMsgUId: string
- startMsgUId: string = ''
Returns Promise<IAsyncRes<void>>

getMessageReadReceiptV4

getMessageReadReceiptV4(conversation: IConversationOption, messageUId: string): Promise<IAsyncRes<IMessageReadReceiptV4Response>>

- Defined in packages/imlib-next/API/message.ts:845
Parameters
- conversation: IConversationOption
- messageUId: string
Returns Promise<IAsyncRes<IMessageReadReceiptV4Response>>

batchGetMessageReadReceiptInfoV4

batchGetMessageReadReceiptInfoV4(conversation: IConversationOption, messageUIds: string[]): Promise<IAsyncRes<IGroupReadReceiptData[]>>

- Defined in packages/imlib-next/API/message.ts:883
Parameters
- conversation: IConversationOption
- messageUIds: string[]
Returns Promise<IAsyncRes<IGroupReadReceiptData[]>>

recallMessage

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

- Defined in packages/imlib-next/API/message.ts:928
Parameters
- conversation: IConversationOption
- options: IRecallMessageOptions
Returns Promise<RCResult<IAReceivedMessage>>

clearHistoryMessages

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

- Defined in packages/imlib-next/API/message.ts:1014
Parameters
- conversation: IConversationOption
- timestamp: number
Returns Promise<IAsyncRes<void>>

batchClearRemoteHistoryMessages

batchClearRemoteHistoryMessages(clearMessageOption: IClearMessageOption[], isDeleteLocal?: boolean): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/message.ts:1049
Parameters
- clearMessageOption: IClearMessageOption[]
- Optional isDeleteLocal: boolean
Returns Promise<IAsyncRes<void>>

sendTypingStatusMessage

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

- Defined in packages/imlib-next/API/message.ts:1229
Parameters
- conversation: IConversationOption
- typingContentType: string
Returns Promise<IAsyncRes<IAReceivedMessage>>

getMessageReader

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

- Defined in packages/imlib-next/API/message.ts:1280
Parameters
- targetId: string
- messageUId: string
- Optional channelId: string
Returns Promise<IAsyncRes<IMessageReaderResponse>>

getFirstUnreadMessage

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

- Defined in packages/imlib-next/API/message.ts:1357
Parameters
- conversation: IConversationOption
Returns Promise<IAsyncRes<IAReceivedMessage | null>>

getFirstUnreadMessageInfo

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

- Defined in packages/imlib-next/API/message.ts:1390
Parameters
- conversation: IConversationOption
Returns Promise<IAsyncRes<IFirstUnreadMessageInfo | null>>

insertMessage

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

- Defined in packages/imlib-next/API/message.ts:1418
Parameters
- conversation: IConversationOption
- content: IReceivedMessage
- options: IInsertOptions = {}
Returns Promise<IAsyncRes<IAReceivedMessage>>

getUnreadMentionedMessages

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

- Defined in packages/imlib-next/API/message.ts:1487
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 packages/imlib-next/API/message.ts:1517
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 packages/imlib-next/API/message.ts:1560
Parameters
- conversation: IConversationOption
- timestamp: number
- cleanSpace: boolean
Returns Promise<IAsyncRes<void>>

clearMessages

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

- Defined in packages/imlib-next/API/message.ts:1610
Parameters
- conversation: IConversationOption
Returns Promise<IAsyncRes<void>>

searchConversationByContent

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

- Defined in packages/imlib-next/API/message.ts:1638
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 packages/imlib-next/API/message.ts:1690
Parameters
- conversation: IConversationOption
- timestamp: number
Returns Promise<IAsyncRes<void>>

setMessageReceivedStatus

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

- Defined in packages/imlib-next/API/message.ts:1728
Parameters
- messageId: number
- receivedStatus: number
Returns Promise<IAsyncRes<void>>

requestStreamMessageContent

requestStreamMessageContent(messageUId: string): Promise<RCResult>

- Defined in packages/imlib-next/API/message.ts:1754
Parameters
- messageUId: string
Returns Promise<RCResult>

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>

setNotificationQuietHoursWithSetting

setNotificationQuietHoursWithSetting(opts: INotificationQuietHoursSetting): Promise<RCResult>

- Defined in packages/imlib-next/API/ntf-quiet-setting.ts:6
Parameters
- opts: INotificationQuietHoursSetting
Returns Promise<RCResult>

removeNotificationQuietHoursSetting

removeNotificationQuietHoursSetting(): Promise<RCResult>

- Defined in packages/imlib-next/API/ntf-quiet-setting.ts:10
Returns Promise<RCResult>

getNotificationQuietHoursSetting

getNotificationQuietHoursSetting(): Promise<RCResult<INotificationQuietHoursSetting>>

- Defined in packages/imlib-next/API/ntf-quiet-setting.ts:14
Returns Promise<RCResult<INotificationQuietHoursSetting>>

setProxy

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

- Defined in packages/imlib-next/API/proxy.ts:7
Parameters
- proxy: null | IProxy
Returns IPromiseResult<IProxy>

getProxy

getProxy(): IPromiseResult<IProxy>

- Defined in packages/imlib-next/API/proxy.ts:37
Returns IPromiseResult<IProxy>

testProxy

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

- Defined in packages/imlib-next/API/proxy.ts:53
Parameters
- proxy: IProxy
- testHost: string
Returns IPromiseResult<IResponse>

unSubscribeUserStatus

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

- Defined in packages/imlib-next/API/subscribe.ts:65
Parameters
- userIds: string[]
- subscribeType: SubscribeType
Returns Promise<IAsyncRes<void>>

getSubscribeUserList

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

- Defined in packages/imlib-next/API/subscribe.ts:95
Parameters
- subscribeType: SubscribeType
- pageSize: number
- offset: number
Returns Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>

getSubscribeUserStatus

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

- Defined in packages/imlib-next/API/subscribe.ts:125
Parameters
- subscribeType: SubscribeType
- userIds: string[]
Returns Promise<IAsyncRes<ISubscribeUserStatusInfo[]>>

updateMyUserProfile

updateMyUserProfile(profile: IUserProfileInfo): Promise<IAsyncRes<IUpdateMyProfileFail>>

- Defined in packages/imlib-next/API/subscribe.ts:157
Parameters
- profile: IUserProfileInfo
Returns Promise<IAsyncRes<IUpdateMyProfileFail>>

getUserProfiles

getUserProfiles(userIds: string[]): Promise<IAsyncRes<IUserProfileInfo[]>>

- Defined in packages/imlib-next/API/subscribe.ts:208
Parameters
- userIds: string[]
Returns Promise<IAsyncRes<IUserProfileInfo[]>>

getMyUserProfile

getMyUserProfile(): Promise<IAsyncRes<IUserProfileInfo>>

- Defined in packages/imlib-next/API/subscribe.ts:228
Returns Promise<IAsyncRes<IUserProfileInfo>>

updateMyUserProfileVisibility

updateMyUserProfileVisibility(visibility: UserProfileVisibility): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/subscribe.ts:243
Parameters
- visibility: UserProfileVisibility
Returns Promise<IAsyncRes<void>>

getMyUserProfileVisibility

getMyUserProfileVisibility(): Promise<IAsyncRes<UserProfileVisibility>>

- Defined in packages/imlib-next/API/subscribe.ts:263
Returns Promise<IAsyncRes<UserProfileVisibility>>

searchUserProfileByUniqueId

searchUserProfileByUniqueId(uniqueId: string): Promise<IAsyncRes<IUserProfileInfo>>

- Defined in packages/imlib-next/API/subscribe.ts:278
Parameters
- uniqueId: string
Returns Promise<IAsyncRes<IUserProfileInfo>>

addTag

addTag(tag: ITagParam): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:11
Parameters
- tag: ITagParam
Returns Promise<IAsyncRes<void>>

removeTag

removeTag(tagId: string): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:35
Parameters
- tagId: string
Returns Promise<IAsyncRes<void>>

updateTag

updateTag(tag: ITagParam): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:53
Parameters
- tag: ITagParam
Returns Promise<IAsyncRes<void>>

getTags

getTags(): Promise<IAsyncRes<ITagInfo[] | undefined>>

- Defined in packages/imlib-next/API/tag.ts:75
Returns Promise<IAsyncRes<ITagInfo[] | undefined>>

getTagsFromConversation

getTagsFromConversation(conversation: IConversationOption): Promise<IAsyncRes<IConversationTag[] | undefined>>

- Defined in packages/imlib-next/API/tag.ts:85
Parameters
- conversation: IConversationOption
Returns Promise<IAsyncRes<IConversationTag[] | undefined>>

addConversationsToTag

addConversationsToTag(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:111
Parameters
- tagId: string
- conversations: IConversationOption[]
Returns Promise<IAsyncRes<void>>

removeConversationsFromTag

removeConversationsFromTag(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:145
Parameters
- tagId: string
- conversations: IConversationOption[]
Returns Promise<IAsyncRes<void>>

removeTagsFromConversation

removeTagsFromConversation(conversation: IConversationOption, tagIds: string[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:179
Parameters
- conversation: IConversationOption
- tagIds: string[]
Returns Promise<IAsyncRes<void>>

removeTagFromConversations

removeTagFromConversations(tagId: string, conversations: IConversationOption[]): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:213
Parameters
- tagId: string
- conversations: IConversationOption[]
Returns Promise<IAsyncRes<void>>

getConversationsFromTagByPage

getConversationsFromTagByPage(tagId: string, count: number, startTime: number): Promise<IAsyncRes<IAReceivedConversationByTag[] | undefined>>

- Defined in packages/imlib-next/API/tag.ts:247
Parameters
- tagId: string
- count: number
- startTime: number
Returns Promise<IAsyncRes<IAReceivedConversationByTag[] | undefined>>

getUnreadCountByTag

getUnreadCountByTag(tagId: string, containMuted: boolean): Promise<IAsyncRes<number | undefined>>

- Defined in packages/imlib-next/API/tag.ts:277
Parameters
- tagId: string
- containMuted: boolean
Returns Promise<IAsyncRes<number | undefined>>

setConversationToTopInTag

setConversationToTopInTag(tagId: string, conversation: IConversationOption, isTop: boolean): Promise<IAsyncRes<void>>

- Defined in packages/imlib-next/API/tag.ts:298
Parameters
- tagId: string
- conversation: IConversationOption
- isTop: boolean
Returns Promise<IAsyncRes<void>>

getUltraGroupList

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

- Defined in packages/imlib-next/API/ultra-group.ts:14
Parameters
- options: IGetUltraGroupListOption = {}
Returns Promise<IAsyncRes<IUltraGroupConversation[]>>

getBlockUltraGroupList

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

- Defined in packages/imlib-next/API/ultra-group.ts:46
Returns Promise<IAsyncRes<IBaseConversationInfo[]>>

sendUltraGroupTypingStatus

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

- Defined in packages/imlib-next/API/ultra-group.ts:62
Parameters
- options: IConversationOption
Returns Promise<IAsyncRes<void>>

getUltraGroupUnreadMentionedCountByTargetId

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

- Defined in packages/imlib-next/API/ultra-group.ts:371
Parameters
- targetId: string
- Optional notificationLevels: NotificationLevel[]
Returns Promise<IAsyncRes<number>>

getUltraGroupDefaultNotificationLevel

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

- Defined in packages/imlib-next/API/ultra-group.ts:405
Parameters
- options: IUltraGroupOption
Returns Promise<IAsyncRes<NotificationLevel>>

setUltraGroupDefaultNotificationLevel

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

- Defined in packages/imlib-next/API/ultra-group.ts:432
Parameters
- options: IUltraGroupOption
- notificationLevel: NotificationLevel
Returns Promise<IAsyncRes<void>>

getUltraGroupUnreadCountByTargetId

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

- Defined in packages/imlib-next/API/ultra-group.ts:468
Parameters
- targetId: string
- Optional notificationLevels: NotificationLevel[]
Returns Promise<IAsyncRes<number>>

getAllUltraGroupUnreadCount

getAllUltraGroupUnreadCount(): Promise<IAsyncRes<number>>

- Defined in packages/imlib-next/API/ultra-group.ts:499
Returns Promise<IAsyncRes<number>>

getAllUltraGroupUnreadMentionedCount

getAllUltraGroupUnreadMentionedCount(): Promise<IAsyncRes<number>>

- Defined in packages/imlib-next/API/ultra-group.ts:518
Returns Promise<IAsyncRes<number>>

getUltraGroupUnreadMentionedMessages

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

- Defined in packages/imlib-next/API/ultra-group.ts:538
Parameters
- options: IUltraGroupUnreadMentionedOption
Returns Promise<IAsyncRes<IUltraUnreadMsg[]>>

getUltraGroupFirstUnreadMessageTimestamp

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

- Defined in packages/imlib-next/API/ultra-group.ts:572
Parameters
- conversation: IUltraGroupOption
Returns Promise<IAsyncRes<IUltraUnreadMsg>>

getUltraGroupUnreadInfoList

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

- Defined in packages/imlib-next/API/ultra-group.ts:599
Parameters
- targetIds: string[]
Returns Promise<IAsyncRes<IUltraGroupUnreadInfo[]>>

createUploadTask

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

- Defined in packages/imlib-next/API/upload.ts:39
Parameters
- uploadInfo: IUploadInfo
Returns Promise<IAsyncRes<UploadTask>>

stopUploadTask

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

- Defined in packages/imlib-next/API/upload.ts:56
Parameters
- taskId: number
Returns Promise<IAsyncRes<boolean>>

upload

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

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

getFileToken

getFileToken(fileType: FileType, fileName?: string, httpMethod?: "POST" | "PUT", queryString?: string): Promise<IAsyncRes<IUploadAuth & { qiniu: string; ossConfig: string }>>

- Defined in packages/imlib-next/API/upload.ts:74
Parameters
- fileType: FileType
- Optional fileName: string
- Optional httpMethod: "POST" | "PUT"
- Optional queryString: string
Returns Promise<IAsyncRes<IUploadAuth & { qiniu: string; ossConfig: string }>>

getDownloadAuth

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

- Defined in packages/imlib-next/API/upload.ts:88
Parameters
- url: string
Returns Promise<IAsyncRes<{ deadline: number; token?: string; downloadAuthInfo?: IDownloadAuth }>>

getFileUrl

getFileUrl(fileType: FileType, filename: string, saveName?: string, _?: { isBosRes: boolean; downloadUrl: string }, serverType?: UploadMethod): Promise<IAsyncRes<{ downloadUrl: string }>>

- Defined in packages/imlib-next/API/upload.ts:107
Parameters
- fileType: FileType
- filename: string
- Optional saveName: string
- Optional _: { isBosRes: boolean; downloadUrl: string }
  - isBosRes: boolean
  - downloadUrl: string
- Optional serverType: UploadMethod
Returns Promise<IAsyncRes<{ downloadUrl: string }>>

Const ConnectType

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

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
Optional userIdList?: string[]

IRecallMessageOptions

IRecallMessageOptions: Omit<IRecallMsgOptions, "pushContent">

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; environment?: string }

Type declaration

appkey: string
Optional logLevel?: LogLevel
Optional logOutputLevel?: EnableLogL
logStdout?:function
- logStdout(logLevel: LogLevel, content: string): void
- - Defined in packages/imlib-next/common/type.ts:10
  Parameters
  - logLevel: LogLevel
  - content: string
  Returns void
Optional navigators?: string[]
Optional connectType?: "websocket" | "comet"
Optional customCMP?: string[]
Optional indexDBSwitch?: boolean
Optional checkCA?: boolean
Optional uploadDomain?: string
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
Optional areaCode?: AreaCode
Optional logServerUrl?: string
Optional environment?: string

GetHistoryMessageOption

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

Type declaration

Optional timestamp?: number
Optional count?: number
Optional order?: 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; PRIVATE_MESSAGE_DELIVERED: any; GROUP_MESSAGE_DELIVERED: any; MESSAGE_READ_RECEIPT_V4: any; SYNC_READ_STATUS: any; SUBSCRIBED_USER_STATUS_CHANGE: any; SUBSCRIBED_RELATION_CHANGE: any; SYNC_SUBSCRIBED_USER_STATUS_FINISHED: any; OWN_USER_PROFILE_CHANGED: any; GROUP_OPERATION: any; GROUP_INFO_CHANGED: any; GROUP_MEMBER_INFO_CHANGED: any; GROUP_APPLICATION_EVENT: any; GROUP_REMARK_CHANGED_SYNC: any; GROUP_FOLLOWS_CHANGED_SYNC: any; FRIEND_ADDED: any; FRIEND_DELETE: any; FRIEND_APPLICATION_STATUS_CHANGED: any; FRIEND_CLEARED: any; FRIEND_INFO_CHANGED_SYNC: any; DATABASE_UPGRADE_WILL_START: any; DATABASE_UPGRADING: any; DATABASE_UPGRADE_DID_COMPLETE: any; STREAM_MESSAGE_RESPONSE: any }

Type declaration

CONNECTING:function
- CONNECTING(): void
- - Defined in packages/imlib-next/core/message-bus.ts:35
  Returns void
CONNECTED:function
- CONNECTED(): void
- - Defined in packages/imlib-next/core/message-bus.ts:36
  Returns void
DISCONNECT:function
- DISCONNECT(code: ErrorCode): void
- - Defined in packages/imlib-next/core/message-bus.ts:37
  Parameters
  - code: ErrorCode
  Returns void
SUSPEND:function
- SUSPEND(code: ErrorCode): void
- - Defined in packages/imlib-next/core/message-bus.ts:38
  Parameters
  - code: ErrorCode
  Returns void
MESSAGES:function
- MESSAGES(messages: IMessagesEvent): void
- - Defined in packages/imlib-next/core/message-bus.ts:39
  Parameters
  - messages: IMessagesEvent
  Returns void
READ_RECEIPT_RECEIVED:function
- READ_RECEIPT_RECEIVED(event: IReadReceiptReceivedEvent): void
- - Defined in packages/imlib-next/core/message-bus.ts:40
  Parameters
  - event: IReadReceiptReceivedEvent
  Returns void
MESSAGE_RECEIPT_REQUEST:function
- MESSAGE_RECEIPT_REQUEST(event: IMessageReceiptRequestEvent): void
- - Defined in packages/imlib-next/core/message-bus.ts:41
  Parameters
  - event: IMessageReceiptRequestEvent
  Returns void
MESSAGE_RECEIPT_RESPONSE:function
- MESSAGE_RECEIPT_RESPONSE(event: IMessageReceiptResponseEvent): void
- - Defined in packages/imlib-next/core/message-bus.ts:42
  Parameters
  - event: IMessageReceiptResponseEvent
  Returns void
CONVERSATION:function
- CONVERSATION(event: IConversationEvent): void
- - Defined in packages/imlib-next/core/message-bus.ts:43
  Parameters
  - event: IConversationEvent
  Returns void
CHATROOM:function
- CHATROOM(event: IChatroomListenerData): void
- - Defined in packages/imlib-next/core/message-bus.ts:44
  Parameters
  - event: IChatroomListenerData
  Returns void
EXPANSION:function
- EXPANSION(event: IExpansionListenerData): void
- - Defined in packages/imlib-next/core/message-bus.ts:45
  Parameters
  - event: IExpansionListenerData
  Returns void
PULL_OFFLINE_MESSAGE_FINISHED:function
- PULL_OFFLINE_MESSAGE_FINISHED(): void
- - Defined in packages/imlib-next/core/message-bus.ts:46
  Returns void
TAG:function
- TAG(): void
- - Defined in packages/imlib-next/core/message-bus.ts:47
  Returns void
CONVERSATION_TAG:function
- CONVERSATION_TAG(): void
- - Defined in packages/imlib-next/core/message-bus.ts:48
  Returns void
TYPING_STATUS:function
- TYPING_STATUS(event: ITypingStatusEvent): void
- - Defined in packages/imlib-next/core/message-bus.ts:49
  Parameters
  - event: ITypingStatusEvent
  Returns void
MESSAGE_BLOCKED:function
- MESSAGE_BLOCKED(data: IBlockedMessageInfo): void
- - Defined in packages/imlib-next/core/message-bus.ts:50
  Parameters
  - data: IBlockedMessageInfo
  Returns void
ULTRA_GROUP_ENABLE:function
- ULTRA_GROUP_ENABLE(list: IAReceivedConversation[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:51
  Parameters
  - list: IAReceivedConversation[]
  Returns void
OPERATE_STATUS:function
- OPERATE_STATUS(status: IOperateStatusNotify): void
- - Defined in packages/imlib-next/core/message-bus.ts:52
  Parameters
  - status: IOperateStatusNotify
  Returns void
ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED:function
- ULTRA_GROUP_MESSAGE_EXPANSION_UPDATED(list: IAReceivedMessage[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:53
  Parameters
  - list: IAReceivedMessage[]
  Returns void
ULTRA_GROUP_MESSAGE_MODIFIED:function
- ULTRA_GROUP_MESSAGE_MODIFIED(list: IAReceivedMessage[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:54
  Parameters
  - list: IAReceivedMessage[]
  Returns void
ULTRA_GROUP_MESSAGE_RECALLED:function
- ULTRA_GROUP_MESSAGE_RECALLED(list: IAReceivedMessage[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:55
  Parameters
  - list: IAReceivedMessage[]
  Returns void
ULTRA_GROUP_CHANNEL_TYPE_CHANGE:function
- ULTRA_GROUP_CHANNEL_TYPE_CHANGE(list: IUltraChannelChangeInfo[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:56
  Parameters
  - list: IUltraChannelChangeInfo[]
  Returns void
ULTRA_GROUP_CHANNEL_DELETE:function
- ULTRA_GROUP_CHANNEL_DELETE(list: IUltraChannelDeleteInfo[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:57
  Parameters
  - list: IUltraChannelDeleteInfo[]
  Returns void
ULTRA_GROUP_CHANNEL_USER_KICKED:function
- ULTRA_GROUP_CHANNEL_USER_KICKED(list: IUltraChannelUserKickedInfo[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:58
  Parameters
  - list: IUltraChannelUserKickedInfo[]
  Returns void
USER_GROUP_STATUS:function
- USER_GROUP_STATUS(list: IUserGroupStatusInfo): void
- - Defined in packages/imlib-next/core/message-bus.ts:59
  Parameters
  - list: IUserGroupStatusInfo
  Returns void
PRIVATE_MESSAGE_DELIVERED:function
- PRIVATE_MESSAGE_DELIVERED(list: IMessageDeliver[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:60
  Parameters
  - list: IMessageDeliver[]
  Returns void
GROUP_MESSAGE_DELIVERED:function
- GROUP_MESSAGE_DELIVERED(list: IGroupMessageDeliverStatus[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:61
  Parameters
  - list: IGroupMessageDeliverStatus[]
  Returns void
MESSAGE_READ_RECEIPT_V4:function
- MESSAGE_READ_RECEIPT_V4(data: IReadReceiptData): void
- - Defined in packages/imlib-next/core/message-bus.ts:62
  Parameters
  - data: IReadReceiptData
  Returns void
SYNC_READ_STATUS:function
- SYNC_READ_STATUS(list: ISyncReadStatusData): void
- - Defined in packages/imlib-next/core/message-bus.ts:63
  Parameters
  - list: ISyncReadStatusData
  Returns void
SUBSCRIBED_USER_STATUS_CHANGE:function
- SUBSCRIBED_USER_STATUS_CHANGE(data: ISubscribeUserStatusInfo[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:64
  Parameters
  - data: ISubscribeUserStatusInfo[]
  Returns void
SUBSCRIBED_RELATION_CHANGE:function
- SUBSCRIBED_RELATION_CHANGE(data: ISubscribeRelationInfo[]): void
- - Defined in packages/imlib-next/core/message-bus.ts:65
  Parameters
  - data: ISubscribeRelationInfo[]
  Returns void
SYNC_SUBSCRIBED_USER_STATUS_FINISHED:function
- SYNC_SUBSCRIBED_USER_STATUS_FINISHED(type: SubscribeType): void
- - Defined in packages/imlib-next/core/message-bus.ts:66
  Parameters
  - type: SubscribeType
  Returns void
OWN_USER_PROFILE_CHANGED:function
- OWN_USER_PROFILE_CHANGED(data: IUserProfileInfo): void
- - Defined in packages/imlib-next/core/message-bus.ts:67
  Parameters
  - data: IUserProfileInfo
  Returns void
GROUP_OPERATION:function
- GROUP_OPERATION(data: IGroupOperationInfo): void
- - Defined in packages/imlib-next/core/message-bus.ts:69
  Parameters
  - data: IGroupOperationInfo
  Returns void
GROUP_INFO_CHANGED:function
- GROUP_INFO_CHANGED(data: IGroupInfoChanged): void
- - Defined in packages/imlib-next/core/message-bus.ts:70
  Parameters
  - data: IGroupInfoChanged
  Returns void
GROUP_MEMBER_INFO_CHANGED:function
- GROUP_MEMBER_INFO_CHANGED(data: IGroupMemberInfoChanged): void
- - Defined in packages/imlib-next/core/message-bus.ts:71
  Parameters
  - data: IGroupMemberInfoChanged
  Returns void
GROUP_APPLICATION_EVENT:function
- GROUP_APPLICATION_EVENT(data: IGroupApplicationInfo): void
- - Defined in packages/imlib-next/core/message-bus.ts:72
  Parameters
  - data: IGroupApplicationInfo
  Returns void
GROUP_REMARK_CHANGED_SYNC:function
- GROUP_REMARK_CHANGED_SYNC(data: IGroupRemarkChangedSync): void
- - Defined in packages/imlib-next/core/message-bus.ts:73
  Parameters
  - data: IGroupRemarkChangedSync
  Returns void
GROUP_FOLLOWS_CHANGED_SYNC:function
- GROUP_FOLLOWS_CHANGED_SYNC(data: IGroupFollowsChangedSync): void
- - Defined in packages/imlib-next/core/message-bus.ts:74
  Parameters
  - data: IGroupFollowsChangedSync
  Returns void
FRIEND_ADDED:function
- FRIEND_ADDED(data: IFriendAdd): void
- - Defined in packages/imlib-next/core/message-bus.ts:76
  Parameters
  - data: IFriendAdd
  Returns void
FRIEND_DELETE:function
- FRIEND_DELETE(data: IFriendDelete): void
- - Defined in packages/imlib-next/core/message-bus.ts:77
  Parameters
  - data: IFriendDelete
  Returns void
FRIEND_APPLICATION_STATUS_CHANGED:function
- FRIEND_APPLICATION_STATUS_CHANGED(data: IFriendApplicationStatusChange): void
- - Defined in packages/imlib-next/core/message-bus.ts:78
  Parameters
  - data: IFriendApplicationStatusChange
  Returns void
FRIEND_CLEARED:function
- FRIEND_CLEARED(data: number): void
- - Defined in packages/imlib-next/core/message-bus.ts:79
  Parameters
  - data: number
  Returns void
FRIEND_INFO_CHANGED_SYNC:function
- FRIEND_INFO_CHANGED_SYNC(data: IFriendInfoChangedSync): void
- - Defined in packages/imlib-next/core/message-bus.ts:80
  Parameters
  - data: IFriendInfoChangedSync
  Returns void
DATABASE_UPGRADE_WILL_START:function
- DATABASE_UPGRADE_WILL_START(): void
- - Defined in packages/imlib-next/core/message-bus.ts:81
  Returns void
DATABASE_UPGRADING:function
- DATABASE_UPGRADING(progress: number): void
- - Defined in packages/imlib-next/core/message-bus.ts:82
  Parameters
  - progress: number
  Returns void
DATABASE_UPGRADE_DID_COMPLETE:function
- DATABASE_UPGRADE_DID_COMPLETE(code: ErrorCode): void
- - Defined in packages/imlib-next/core/message-bus.ts:83
  Parameters
  - code: ErrorCode
  Returns void
STREAM_MESSAGE_RESPONSE:function
- STREAM_MESSAGE_RESPONSE(evt: IStreamMessageResponseEventData<IAReceivedMessage>): void
- - Defined in packages/imlib-next/core/message-bus.ts:84
  Parameters
  - evt: IStreamMessageResponseEventData<IAReceivedMessage>
  Returns void

IStreamMessageResponseEventData

IStreamMessageResponseEventData: IInnerStreamMessageResponseEventData<IAReceivedMessage>

好友

refuseFriendApplication

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

- Defined in packages/imlib-next/API/friend.ts:91
拒绝加为好友

since
5.12.0

Parameters
- userId: string
  
  拒绝成为好友的用户ID // * @param reason 拒绝原因。非必填项，长度不超过 128 个字符。
Returns Promise<IAsyncRes<void>>

Index

会话

消息

超级群

订阅用户状态

Enum

其他

好友

会话

setConversationNotificationLevel

Parameters

options: IConversationOption

notificationLevel: NotificationLevel

Returns Promise<IAsyncRes<void>>

消息

sendFileMessage

Parameters

conversation: IConversationOption

msgBody: ISendBody

Optional hooks: IUploadHooks

Optional sendOptions: IUploadMessageOption

Returns Promise<IAsyncRes<IAReceivedMessage>>

sendImageMessage

Parameters

conversation: IConversationOption

msgBody: ISendBody

Optional hooks: IUploadHooks

Optional sendOptions: IImageMessageOption

Returns Promise<IAsyncRes<IAReceivedMessage>>

sendGIFMessage

Parameters

conversation: IConversationOption

msgBody: ISendBody

Optional hooks: IUploadHooks

Optional sendOptions: IUploadMessageOption

Returns Promise<IAsyncRes<IAReceivedMessage>>

sendHQVoiceMessage

Parameters

conversation: IConversationOption

msgBody: ISendBody

Optional hooks: IUploadHooks

Optional sendOptions: IUploadMessageOption

Returns Promise<IAsyncRes<IAReceivedMessage>>

sendSightMessage

Parameters

conversation: IConversationOption

msgBody: ISendSightMessageOptions

Optional hooks: IUploadHooks

Optional sendOptions: IUploadMessageOption

Returns Promise<IAsyncRes<IAReceivedMessage>>

sendSyncReadStatusMessage

Parameters

conversation: IConversationOption

timestamp: number

Returns Promise<IAsyncRes<void>>

deleteMessages

Parameters

conversation: IConversationOption

messages: { messageUId: string; sentTime: number; messageDirection: MessageDirection }[]

Returns Promise<IAsyncRes<void>>

updateMessageExpansion

Parameters

expansion: {}

[key: string]: any

message: IAReceivedMessage

Returns Promise<IAsyncRes<void>>

removeMessageExpansionForKey

Parameters

keys: string[]

message: IAReceivedMessage

Returns Promise<IAsyncRes<void>>

registerMessageType

Type Parameters

T

Parameters

messageType: string

isPersited: boolean

isCounted: boolean

Optional searchProps: string[]

Optional isStatusMessage: boolean