Class RCIMIWEngine

constructor

• new RCIMIWEngine(): RCIMIWEngine

  Returns RCIMIWEngine

Static_instance

Staticcreate

• create(appKey: string, options?: RCIMIWEngineOptions): RCIMIWEngine

  创建接口引擎@param context 上下文

  Parameters

  • appKey: string

    开发者后台获取的 AppKey

  • options: RCIMIWEngineOptions = {}

    引擎配置项

  Returns RCIMIWEngine

  引擎实例

destroy

• destroy(): Promise<number>

  销毁引擎 引擎销毁后如果当前未退出登录，SDK 会自动退出，且仍接受 push

  Returns Promise<number>

setDeviceToken

• setDeviceToken(deviceToken: string): Promise<number>

  Parameters

  • deviceToken: string

  Returns Promise<number>

registerNativeCustomMessage

• registerNativeCustomMessage(
      messageIdentifier: string,
      persistentFlag: RCIMIWNativeCustomMessagePersistentFlag,
  ): Promise<number>

  注册原生自定义普通消息

  Parameters

  • messageIdentifier: string

    消息的唯一标识

  • persistentFlag: RCIMIWNativeCustomMessagePersistentFlag

    消息的存储策略

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功，非 0 代表当前接口调用操作失败，详细错误参考错误码

registerNativeCustomMediaMessage

• registerNativeCustomMediaMessage(
      messageIdentifier: string,
      persistentFlag: RCIMIWNativeCustomMessagePersistentFlag,
  ): Promise<number>

  注册原生自定义媒体消息

  Parameters

  • messageIdentifier: string

    消息的唯一标识

  • persistentFlag: RCIMIWNativeCustomMessagePersistentFlag

    消息的存储策略

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功，非 0 代表当前接口调用操作失败，详细错误参考错误码

connect

• connect(
      token: string,
      timeout: number,
      callback?: RCIMIWConnectCallback,
  ): Promise<number>

  连接融云服务器，在整个应用程序全局，只需要调用一次。调用此接口返回非业务错误码时，SDK 会启动重连机制进行重连；如果仍没有连接成功，会在设备网络状态变化时再次进行重连。

  Parameters

  • token: string

    调用 server api 获取到的 token

  • timeout: number

    连接超时时间，单位：秒。 timeout ≤ 0，则 IM 将一直连接，直到连接成功或者无法连接（如 token 非法） timeout > 0，则 IM 将最多连接 timeout 秒 如果在 timeout 秒内连接成功，后面再发生了网络变化或前后台切换，SDK 会自动重连； 如果在 timeout 秒无法连接成功则不再进行重连，通过 listener 告知连接超时，您需要再自行调用 connect 接口

  • Optionalcallback: RCIMIWConnectCallback

    链接事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

disconnect

• disconnect(receivePush: boolean): Promise<number>

  断开链接 注：因为 SDK 在前后台切换或者网络出现异常都会自动重连，保证连接可靠性。 所以除非您的 App 逻辑需要登出，否则一般不需要调用此方法进行手动断开

  Parameters

  • receivePush: boolean

    退出后是否接收 push，true:断开后接收远程推送，false:断开后不再接收远程推送

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getConnectionStatus

• getConnectionStatus(): Promise<RCIMIWConnectionStatus>

  获取当前 IM 服务连接状态

  Returns Promise<RCIMIWConnectionStatus>

  当前连接状态

createTextMessage

• createTextMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      text: string,
  ): Promise<RCIMIWTextMessage>

  构建文本消息

  Parameters

  • type: RCIMIWConversationType

    会话类型，

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • text: string

    文本内容

  Returns Promise<RCIMIWTextMessage>

  文本消息实体

createImageMessage

• createImageMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
  ): Promise<RCIMIWImageMessage>

  构建图片消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • path: string

    图片消息的本地路径，必须为有效路径

  Returns Promise<RCIMIWImageMessage>

  图片消息实体

createFileMessage

• createFileMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
  ): Promise<RCIMIWFileMessage>

  构建文件消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • path: string

    文件消息的本地路径，必须为有效路径

  Returns Promise<RCIMIWFileMessage>

  文件消息实体

createSightMessage

• createSightMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
      duration: number,
  ): Promise<RCIMIWSightMessage>

  构建小视频消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • path: string

    小视频消息的本地路径，必须为有效路径

  • duration: number

    小视频消息的视频时长

  Returns Promise<RCIMIWSightMessage>

  视频消息实体

createVoiceMessage

• createVoiceMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
      duration: number,
  ): Promise<RCIMIWVoiceMessage>

  构建语音消息 (高清语音)

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • path: string

    语音消息的本地路径，必须为有效路径

  • duration: number

    语音消息的消息时长

  Returns Promise<RCIMIWVoiceMessage>

  语音消息的实体

createReferenceMessage

• createReferenceMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      referenceMessage: RCIMIWMessage,
      text: string,
  ): Promise<RCIMIWReferenceMessage>

  构建引用消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • referenceMessage: RCIMIWMessage

    引用的消息

  • text: string

    引用的文本内容

  Returns Promise<RCIMIWReferenceMessage>

  引用消息实体

createGIFMessage

• createGIFMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
  ): Promise<RCIMIWGIFMessage>

  构建 GIF 消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • path: string

    GIF 消息的本地路径

  Returns Promise<RCIMIWGIFMessage>

  GIF 消息实体

createCustomMessage

• createCustomMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      policy: RCIMIWCustomMessagePolicy,
      messageIdentifier: string,
      fields: Map<string, string>,
  ): Promise<RCIMIWCustomMessage>

  构建自定义消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • policy: RCIMIWCustomMessagePolicy

    消息的存储策略

  • messageIdentifier: string

    消息的标识符，需唯一

  • fields: Map<string, string>

    消息的内容键值对

  Returns Promise<RCIMIWCustomMessage>

  自定义消息实体

createLocationMessage

• createLocationMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      longitude: number,
      latitude: number,
      poiName: string,
      thumbnailPath: string,
  ): Promise<RCIMIWLocationMessage>

  构建位置消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • longitude: number

    经度

  • latitude: number

    纬度

  • poiName: string

    POI 信息

  • thumbnailPath: string

    缩略图本地路径，必须为有效路径

  Returns Promise<RCIMIWLocationMessage>

  位置消息实体

createNativeCustomMessage

• createNativeCustomMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messageIdentifier: string,
      fields: Map<string, Object>,
  ): Promise<RCIMIWNativeCustomMessage>

  构建原生自定义普通消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • messageIdentifier: string

    消息的标识符，需唯一

  • fields: Map<string, Object>

    消息的内容键值对

  Returns Promise<RCIMIWNativeCustomMessage>

  原生自定义普通消息

createNativeCustomMediaMessage

• createNativeCustomMediaMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messageIdentifier: string,
      path: string,
      fields: Map<string, Object>,
  ): Promise<RCIMIWNativeCustomMediaMessage>

  构建原生自定义媒体消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • messageIdentifier: string

    消息的标识符，需唯一

  • path: string

    媒体文件的本地路径，必须为有效路径

  • fields: Map<string, Object>

    消息的内容键值对

  Returns Promise<RCIMIWNativeCustomMediaMessage>

  原生自定义媒体消息

sendMessage

• sendMessage(
      message: RCIMIWMessage,
      callback?: RCIMIWSendMessageCallback,
  ): Promise<number>

  发送普通消息

  Parameters

  • message: RCIMIWMessage

    发送的消息实体

  • Optionalcallback: RCIMIWSendMessageCallback

    发送消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

sendMediaMessage

• sendMediaMessage(
      message: RCIMIWMediaMessage,
      listener?: RCIMIWSendMediaMessageListener,
  ): Promise<number>

  发送媒体消息

  Parameters

  • message: RCIMIWMediaMessage

    发送的媒体消息实体

  • Optionallistener: RCIMIWSendMediaMessageListener

    发送媒体消息的事件监听

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 [onMediaMessageSending],[onMediaMessageAttached],[onMediaMessageSent]

cancelSendingMediaMessage

• cancelSendingMediaMessage(
      message: RCIMIWMediaMessage,
      callback?: IRCIMIWCancelSendingMediaMessageCallback,
  ): Promise<number>

  取消发送媒体消息

  Parameters

  • message: RCIMIWMediaMessage

    需要取消发送的媒体消息实体

  • Optionalcallback: IRCIMIWCancelSendingMediaMessageCallback

    取消发送媒体消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

downloadMediaMessage

• downloadMediaMessage(
      message: RCIMIWMediaMessage,
      listener?: RCIMIWDownloadMediaMessageListener,
  ): Promise<number>

  下载媒体消息

  Parameters

  • message: RCIMIWMediaMessage

    需要下载的媒体消息实体

  • Optionallistener: RCIMIWDownloadMediaMessageListener

    下载媒体消息的事件监听

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

cancelDownloadingMediaMessage

• cancelDownloadingMediaMessage(
      message: RCIMIWMediaMessage,
      callback?: IRCIMIWCancelDownloadingMediaMessageCallback,
  ): Promise<number>

  取消下载媒体消息

  Parameters

  • message: RCIMIWMediaMessage

    需要取消下载的媒体消息实体

  • Optionalcallback: IRCIMIWCancelDownloadingMediaMessageCallback

    取消下载媒体消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getConversation

• getConversation(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetConversationCallback,
  ): Promise<number>

  获取某个会话

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可

  • Optionalcallback: IRCIMIWGetConversationCallback

    获取会话事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getConversations

• getConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      startTime: number,
      count: number,
      callback?: IRCIMIWGetConversationsCallback,
  ): Promise<number>

  获取某些会话

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    会话类型

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可

  • startTime: number

    时间戳（毫秒），获取小于此时间戳的会话，传 0 为查询最新数据

  • count: number

    查询的数量， 0 < count ≤ 50

  • Optionalcallback: IRCIMIWGetConversationsCallback

    获取会话列表事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getConversationsWithPriority

• getConversationsWithPriority(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      startTime: number,
      count: number,
      topPriority: boolean,
      callback?: IRCIMIWGetConversationsCallback,
  ): Promise<number>

  获取某些会话，可设置是否优先置顶

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    会话类型

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可

  • startTime: number

    时间戳（毫秒），获取小于此时间戳的会话，传 0 为查询最新数据

  • count: number

    查询的数量， 0 < count <= 50

  • topPriority: boolean

    是否优先置顶，true: 优先置顶，false: 不优先置顶

  • Optionalcallback: IRCIMIWGetConversationsCallback

    获取会话列表事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUnreadConversations

• getUnreadConversations(
      conversationTypes: RCIMIWConversationType[],
      callback?: IRCIMIWGetUnreadConversationsCallback,
  ): Promise<number>

  获取指定类型的含有未读消息的会话列表

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    支持单聊、群聊、系统会话

  • Optionalcallback: IRCIMIWGetUnreadConversationsCallback

    获取会话列表事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getRemoteConversationList

• getRemoteConversationList(callback?: IRCIMIWOperationCallback): Promise<number>

  从服务器拉取会话列表

  Parameters

  • Optionalcallback: IRCIMIWOperationCallback

    操作回调

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调

removeConversationWithDeleteRemote

• removeConversationWithDeleteRemote(
      type: RCIMIWConversationType,
      targetId: string,
      deleteRemote: boolean,
      callback?: IRCIMIWRemoveConversationCallback,
  ): Promise<number>

  移除某个会话，可设置是否删除远端会话

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • deleteRemote: boolean

    是否删除远端会话

  • Optionalcallback: IRCIMIWRemoveConversationCallback

    移除会话事件回调。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

removeConversation

• removeConversation(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWRemoveConversationCallback,
  ): Promise<number>

  移除某个会话

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可

  • Optionalcallback: IRCIMIWRemoveConversationCallback

    移除会话事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

removeConversations

• removeConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      callback?: IRCIMIWRemoveConversationsCallback,
  ): Promise<number>

  根据会话类型移除会话

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    会话类型集合

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWRemoveConversationsCallback

    移除会话列表事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUnreadCount

• getUnreadCount(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetUnreadCountCallback,
  ): Promise<number>

  获取某个会话的未读数 注：不支持聊天室！

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetUnreadCountCallback

    获取会话未读数事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getTotalUnreadCount

• getTotalUnreadCount(
      channelId: string,
      callback?: IRCIMIWGetTotalUnreadCountCallback,
  ): Promise<number>

  获取所有未读数

  Parameters

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetTotalUnreadCountCallback

    获取所有未读数事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUnreadMentionedCount

• getUnreadMentionedCount(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetUnreadMentionedCountCallback,
  ): Promise<number>

  获取会话中未读的 @ 消息数量。 注：不支持聊天室！

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetUnreadMentionedCountCallback

    获取会话中未读的 @ 消息数量事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUltraGroupAllUnreadCount

• getUltraGroupAllUnreadCount(
      callback?: IRCIMIWGetUltraGroupAllUnreadCountCallback,
  ): Promise<number>

  获取当前用户加入的所有超级群会话的未读消息数的总和。

  Parameters

  • Optionalcallback: IRCIMIWGetUltraGroupAllUnreadCountCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUltraGroupAllUnreadMentionedCount

• getUltraGroupAllUnreadMentionedCount(
      callback?: IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback,
  ): Promise<number>

  获取当前用户加入的所有超级群会话中的未读 @ 消息数的总和。

  Parameters

  • Optionalcallback: IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUltraGroupUnreadCount

• getUltraGroupUnreadCount(
      targetId: string,
      callback?: IRCIMIWGetUltraGroupUnreadCountCallback,
  ): Promise<number>

  获取指定会话的未读消息数

  Parameters

  • targetId: string

    会话 ID

  • Optionalcallback: IRCIMIWGetUltraGroupUnreadCountCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUltraGroupUnreadMentionedCount

• getUltraGroupUnreadMentionedCount(
      targetId: string,
      callback?: IRCIMIWGetUltraGroupUnreadMentionedCountCallback,
  ): Promise<number>

  获取超级群会话中被 @ 的消息数

  Parameters

  • targetId: string

    会话 ID

  • Optionalcallback: IRCIMIWGetUltraGroupUnreadMentionedCountCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUnreadCountByConversationTypes

• getUnreadCountByConversationTypes(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      contain: boolean,
      callback?: IRCIMIWGetUnreadCountByConversationTypesCallback,
  ): Promise<number>

  根据会话类型加载未读数 注：不支持聊天室！

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    会话类型集合

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • contain: boolean

    是否包含免打扰消息的未读消息数。

  • Optionalcallback: IRCIMIWGetUnreadCountByConversationTypesCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUnreadCountByLevels

• getUnreadCountByLevels(
      conversationTypes: RCIMIWConversationType[],
      levels: RCIMIWPushNotificationLevel[],
      callback?: IRCIMIWGetUnreadCountByLevelsCallback,
  ): Promise<number>

  根据会话的免打扰级别加载未读数

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    会话类型列表

  • levels: RCIMIWPushNotificationLevel[]

    免打扰级别列表

  • Optionalcallback: IRCIMIWGetUnreadCountByLevelsCallback

    获取会话未读消息数回调

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果通过接口 callback 回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

clearUnreadCount

• clearUnreadCount(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      timestamp: number,
      callback?: IRCIMIWClearUnreadCountCallback,
  ): Promise<number>

  清除某个会话中的未读消息数。 注：不支持聊天室！

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • timestamp: number

    该会话已阅读的最后一条消息的发送时间戳，清除所有传入当前最新时间戳

  • Optionalcallback: IRCIMIWClearUnreadCountCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

saveDraftMessage

• saveDraftMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      draft: string,
      callback?: IRCIMIWSaveDraftMessageCallback,
  ): Promise<number>

  保存会话草稿信息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • draft: string

    草稿的文字内容。

  • Optionalcallback: IRCIMIWSaveDraftMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getDraftMessage

• getDraftMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetDraftMessageCallback,
  ): Promise<number>

  获取会话中的草稿信息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetDraftMessageCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

clearDraftMessage

• clearDraftMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWClearDraftMessageCallback,
  ): Promise<number>

  删除指定会话中的草稿信息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWClearDraftMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getBlockedConversations

• getBlockedConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      callback?: IRCIMIWGetBlockedConversationsCallback,
  ): Promise<number>

  获取免打扰的会话列表。

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    会话类型集合

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetBlockedConversationsCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

changeConversationTopStatus

• changeConversationTopStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      top: boolean,
      callback?: IRCIMIWChangeConversationTopStatusCallback,
  ): Promise<number>

  设置会话的置顶状态。若会话不存在，调用此方法 SDK 自动创建会话并置顶。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • top: boolean

    是否置顶

  • Optionalcallback: IRCIMIWChangeConversationTopStatusCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

changeConversationTopStatusWithUpdateTme

• changeConversationTopStatusWithUpdateTme(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      top: boolean,
      updateOperationTime: boolean,
      callback?: IRCIMIWChangeConversationTopStatusCallback,
  ): Promise<number>

  设置会话的置顶状态。若会话不存在，调用此方法 SDK 自动创建会话并置顶。

  Parameters

  • type: RCIMIWConversationType

    conversation type

  • targetId: string

    conversation ID

  • channelId: string

    频道 ID，仅支持ultra group使用，其他conversation type传 null 即可。

  • top: boolean

    是否置顶

  • updateOperationTime: boolean

    是否更新操作事件，默认不更新，如果需要更新请传 true

  • Optionalcallback: IRCIMIWChangeConversationTopStatusCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getConversationTopStatus

• getConversationTopStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetConversationTopStatusCallback,
  ): Promise<number>

  获取会话的置顶状态

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetConversationTopStatusCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

syncConversationReadStatus

• syncConversationReadStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      timestamp: number,
      callback?: IRCIMIWSyncConversationReadStatusCallback,
  ): Promise<number>

  同步会话阅读状态。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • timestamp: number

    会话中已读的最后一条消息的发送时间戳

  • Optionalcallback: IRCIMIWSyncConversationReadStatusCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

sendTypingStatus

• sendTypingStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      currentType: string,
  ): Promise<number>

  向会话中发送正在输入的状态，目前只支持单聊。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • currentType: string

    当前的状态

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getMessages

• getMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      sentTime: number,
      order: RCIMIWTimeOrder,
      policy: RCIMIWMessageOperationPolicy,
      count: number,
      callback?: IRCIMIWGetMessagesCallback,
  ): Promise<number>

  加载历史消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • sentTime: number

    当前消息时间戳

  • order: RCIMIWTimeOrder

    获取消息的方向。BEFORE：获取 sentTime 之前的消息 （时间递减），AFTER：获取 sentTime 之后的消息 （时间递增）

  • policy: RCIMIWMessageOperationPolicy

    消息的加载策略。LOCAL：只加载本地，REMOTE：只加载远端，LOCAL_REMOTE：本地远端都加载

  • count: number

    获取的消息数量，0 < count ≤ 20

  • Optionalcallback: IRCIMIWGetMessagesCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getMessageById

• getMessageById(
      messageId: number,
      callback?: IRCIMIWGetMessageCallback,
  ): Promise<number>

  根据消息 id 获取消息体（本地数据库索引唯一值）。

  Parameters

  • messageId: number

    消息的 messageId，可在消息对象中获取

  • Optionalcallback: IRCIMIWGetMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getMessageByUId

• getMessageByUId(
      messageUId: string,
      callback?: IRCIMIWGetMessageCallback,
  ): Promise<number>

  通过全局唯一 id 获取消息实体。

  Parameters

  • messageUId: string

    消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值。

  • Optionalcallback: IRCIMIWGetMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getMessagesAroundTime

• getMessagesAroundTime(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      sentTime: number,
      beforeCount: number,
      afterCount: number,
      callback?: IRCIMIWGetMessagesAroundTimeCallback,
  ): Promise<number>

  在会话中获取指定消息的前后指定数量的消息。返回的消息列表中会包含指定的消息。消息列表时间顺序从新到旧。

  Parameters

  • type: RCIMIWConversationType

    会话类型。

  • targetId: string

    会话 ID。

  • channelId: string

    消息所属会话的业务标识。

  • sentTime: number

    指定消息的发送时间，不能为 0。单位：毫秒。

  • beforeCount: number

    指定消息的前部分消息数量。

  • afterCount: number

    指定消息的后部分消息数量。

  • Optionalcallback: IRCIMIWGetMessagesAroundTimeCallback

    获取结果回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果通过接口 callback 回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getLocalMessagesByMessageTypes

• getLocalMessagesByMessageTypes(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messageTypes: RCIMIWMessageType[],
      sentTime: number,
      order: RCIMIWTimeOrder,
      count: number,
      callback?: IRCIMIWGetMessagesCallback,
  ): Promise<number>

  获取会话中指定类型的消息。

  Parameters

  • type: RCIMIWConversationType

    会话类型。

  • targetId: string

    会话 ID。

  • channelId: string

    消息所属会话的业务标识。

  • messageTypes: RCIMIWMessageType[]

    消息类型列表。

  • sentTime: number

    消息发送时间戳，0 表示最新的消息

  • order: RCIMIWTimeOrder

    获取消息的方向。BEFORE：获取 sentTime 之前的消息 （时间递减），AFTER：获取 sentTime 之后的消息 （时间递增）

  • count: number

    获取的消息数量

  • Optionalcallback: IRCIMIWGetMessagesCallback

    获取结果回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果通过接口 callback 回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getFirstUnreadMessage

• getFirstUnreadMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetFirstUnreadMessageCallback,
  ): Promise<number>

  获取第一条未读消息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetFirstUnreadMessageCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getUnreadMentionedMessages

• getUnreadMentionedMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetUnreadMentionedMessagesCallback,
  ): Promise<number>

  获取会话中未读的 @ 消息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • Optionalcallback: IRCIMIWGetUnreadMentionedMessagesCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

insertMessage

• insertMessage(
      message: RCIMIWMessage,
      callback?: IRCIMIWInsertMessageCallback,
  ): Promise<number>

  插入一条消息

  Parameters

  • message: RCIMIWMessage

    插入的消息

  • Optionalcallback: IRCIMIWInsertMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

insertMessages

• insertMessages(
      messages: RCIMIWMessage[],
      callback?: IRCIMIWInsertMessagesCallback,
  ): Promise<number>

  插入多条消息，不支持超级群

  Parameters

  • messages: RCIMIWMessage[]

    插入的消息集合

  • Optionalcallback: IRCIMIWInsertMessagesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

clearMessages

• clearMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      timestamp: number,
      policy: RCIMIWMessageOperationPolicy,
      callback?: IRCIMIWClearMessagesCallback,
  ): Promise<number>

  清除消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • timestamp: number

    清除消息截止时间戳，0 ≤ timestamp ≤ 当前会话最后一条消息的 sentTime, 0 清除所有消息，其他值清除小于等于 timestamp 的消息

  • policy: RCIMIWMessageOperationPolicy

    清除的策略

  • Optionalcallback: IRCIMIWClearMessagesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

deleteLocalMessages

• deleteLocalMessages(
      messages: RCIMIWMessage[],
      callback?: IRCIMIWDeleteLocalMessagesCallback,
  ): Promise<number>

  删除本地消息

  Parameters

  • messages: RCIMIWMessage[]

    消息集合

  • Optionalcallback: IRCIMIWDeleteLocalMessagesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

deleteLocalMessageByIds

• deleteLocalMessageByIds(
      messageIds: number[],
      callback?: IRCIMIWDeleteLocalMessageByIdsCallback,
  ): Promise<number>

  根据 messageId 批量删除本地消息

  Parameters

  • messageIds: number[]

    消息的 messageId 集合

  • Optionalcallback: IRCIMIWDeleteLocalMessageByIdsCallback

    事件回调

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

deleteMessages

• deleteMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messages: RCIMIWMessage[],
      callback?: IRCIMIWDeleteMessagesCallback,
  ): Promise<number>

  删除消息

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • messages: RCIMIWMessage[]

    消息集合

  • Optionalcallback: IRCIMIWDeleteMessagesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

recallMessage

• recallMessage(
      message: RCIMIWMessage,
      callback?: IRCIMIWRecallMessageCallback,
  ): Promise<number>

  撤回消息

  Parameters

  • message: RCIMIWMessage

    需要被撤回的消息

  • Optionalcallback: IRCIMIWRecallMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

sendPrivateReadReceiptMessage

• sendPrivateReadReceiptMessage(
      targetId: string,
      channelId: string,
      timestamp: number,
      callback?: IRCIMIWSendPrivateReadReceiptMessageCallback,
  ): Promise<number>

  发送某个会话中的消息阅读回执

  Parameters

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • timestamp: number

    该会话中已读的最后一条消息的发送时间戳

  • Optionalcallback: IRCIMIWSendPrivateReadReceiptMessageCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

sendGroupReadReceiptRequest

• sendGroupReadReceiptRequest(
      message: RCIMIWMessage,
      callback?: IRCIMIWSendGroupReadReceiptRequestCallback,
  ): Promise<number>

  发起群聊消息已读回执请求

  Parameters

  • message: RCIMIWMessage

    需要请求已读回执的消息

  • Optionalcallback: IRCIMIWSendGroupReadReceiptRequestCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

sendGroupReadReceiptResponse

• sendGroupReadReceiptResponse(
      targetId: string,
      channelId: string,
      messages: RCIMIWMessage[],
      callback?: IRCIMIWSendGroupReadReceiptResponseCallback,
  ): Promise<number>

  发送群聊已读回执

  Parameters

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • messages: RCIMIWMessage[]

    会话中需要发送已读回执的消息列表

  • Optionalcallback: IRCIMIWSendGroupReadReceiptResponseCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

updateMessageExpansion

• updateMessageExpansion(
      messageUId: string,
      expansion: Map<string, string>,
      callback?: IRCIMIWUpdateMessageExpansionCallback,
  ): Promise<number>

  更新消息扩展信息 每条消息携带扩展信息键值对最大值 300个，单次设置扩展信息键值对最大值 20个

  Parameters

  • messageUId: string

    消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值

  • expansion: Map<string, string>

    要更新的消息扩展信息键值对，类型是 HashMap；Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，不支持汉字。Value 可以输入空格

  • Optionalcallback: IRCIMIWUpdateMessageExpansionCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

removeMessageExpansionForKeys

• removeMessageExpansionForKeys(
      messageUId: string,
      keys: string[],
      callback?: IRCIMIWRemoveMessageExpansionForKeysCallback,
  ): Promise<number>

  删除消息扩展信息中特定的键值对

  Parameters

  • messageUId: string

    消息的 messageUid，可在消息对象中获取，且只有发送成功的消息才会有值

  • keys: string[]

    消息扩展信息中待删除的 key 的列表，类型是 ArrayList

  • Optionalcallback: IRCIMIWRemoveMessageExpansionForKeysCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

changeMessageSentStatus

• changeMessageSentStatus(
      messageId: number,
      sentStatus: RCIMIWSentStatus,
      callback?: IRCIMIWChangeMessageSentStatusCallback,
  ): Promise<number>

  设置消息发送状态。

  Parameters

  • messageId: number

    消息的 messageId，可在消息对象中获取

  • sentStatus: RCIMIWSentStatus

    要修改的状态

  • Optionalcallback: IRCIMIWChangeMessageSentStatusCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

changeMessageReceiveStatus

• changeMessageReceiveStatus(
      messageId: number,
      receivedStatus: RCIMIWReceivedStatus,
      callback?: IRCIMIWChangeMessageReceivedStatusCallback,
  ): Promise<number>

  设置消息接收状态。

  Parameters

  • messageId: number

    消息的 messageId，可在消息对象中获取

  • receivedStatus: RCIMIWReceivedStatus

    要修改的状态

  • Optionalcallback: IRCIMIWChangeMessageReceivedStatusCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

changeMessageReceiveStatusInfo

• changeMessageReceiveStatusInfo(
      messageId: number,
      receivedStatusInfo: RCIMIWReceivedStatusInfo,
      callback?: IRCIMIWChangeMessageReceivedStatusInfoCallback,
  ): Promise<number>

  设置消息接收状态。

  Parameters

  • messageId: number

    消息的 messageId，可在消息对象中获取

  • receivedStatusInfo: RCIMIWReceivedStatusInfo

    要修改的状态

  • Optionalcallback: IRCIMIWChangeMessageReceivedStatusInfoCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

updateMessageLocalExtra

• updateMessageLocalExtra(
      messageId: number,
      extra: string,
      callback?: IRCIMIWUpdateMessageLocalExtraCallback,
  ): Promise<number>

  设置消息的附加信息，只能用于本地使用，无法同步到远端。

  Parameters

  • messageId: number

    消息的 messageId，可在消息对象中获取

  • extra: string

    附加信息

  • Optionalcallback: IRCIMIWUpdateMessageLocalExtraCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

joinChatRoom

• joinChatRoom(
      targetId: string,
      messageCount: number,
      autoCreate: boolean,
      callback?: IRCIMIWJoinChatRoomCallback,
  ): Promise<number>

  加入聊天室。

  Parameters

  • targetId: string

    聊天室会话 ID

  • messageCount: number

    进入聊天室拉取消息数目，-1 时不拉取任何消息，0 时拉取 10 条消息，最多只能拉取 50

  • autoCreate: boolean

    是否创建聊天室，TRUE 如果聊天室不存在，sdk 会创建聊天室并加入，如果已存在，则直接加入

  • Optionalcallback: IRCIMIWJoinChatRoomCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

leaveChatRoom

• leaveChatRoom(
      targetId: string,
      callback?: IRCIMIWLeaveChatRoomCallback,
  ): Promise<number>

  退出聊天室。

  Parameters

  • targetId: string

    聊天室会话 ID

  • Optionalcallback: IRCIMIWLeaveChatRoomCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getChatRoomMessages

• getChatRoomMessages(
      targetId: string,
      timestamp: number,
      order: RCIMIWTimeOrder,
      count: number,
      callback?: IRCIMIWGetChatRoomMessagesCallback,
  ): Promise<number>

  获取聊天室历史消息记录。 注：必须先开通聊天室消息云存储功能。

  Parameters

  • targetId: string

    聊天室会话 ID

  • timestamp: number

    起始的消息发送时间戳

  • order: RCIMIWTimeOrder

    拉取顺序 0:倒序，1:正序

  • count: number

    要获取的消息数量，0 < count ≤ 50。

  • Optionalcallback: IRCIMIWGetChatRoomMessagesCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

addChatRoomEntry

• addChatRoomEntry(
      targetId: string,
      key: string,
      value: string,
      deleteWhenLeft: boolean,
      overwrite: boolean,
      callback?: IRCIMIWAddChatRoomEntryCallback,
  ): Promise<number>

  设置聊天室自定义属性。

  Parameters

  • targetId: string

    聊天室会话 ID

  • key: string

    聊天室属性名称，Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 128 个字符

  • value: string

    聊天室属性对应的值，最大长度 4096 个字符

  • deleteWhenLeft: boolean

    用户掉线或退出时，是否自动删除该 Key、Value 值

  • overwrite: boolean

    如果当前 key 存在，是否进行覆盖

  • Optionalcallback: IRCIMIWAddChatRoomEntryCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

addChatRoomEntries

• addChatRoomEntries(
      targetId: string,
      entries: Map<string, string>,
      deleteWhenLeft: boolean,
      overwrite: boolean,
      callback?: IRCIMIWAddChatRoomEntriesCallback,
  ): Promise<number>

  批量设置聊天室自定义属性

  Parameters

  • targetId: string

    聊天室会话 ID

  • entries: Map<string, string>

    聊天室属性

  • deleteWhenLeft: boolean

    用户掉线或退出时，是否自动删除该 Key、Value 值

  • overwrite: boolean

    是否强制覆盖

  • Optionalcallback: IRCIMIWAddChatRoomEntriesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getChatRoomEntry

• getChatRoomEntry(
      targetId: string,
      key: string,
      callback?: IRCIMIWGetChatRoomEntryCallback,
  ): Promise<number>

  获取聊天室单个属性。

  Parameters

  • targetId: string

    聊天室会话 ID

  • key: string

    聊天室属性键值

  • Optionalcallback: IRCIMIWGetChatRoomEntryCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getChatRoomAllEntries

• getChatRoomAllEntries(
      targetId: string,
      callback?: IRCIMIWGetChatRoomAllEntriesCallback,
  ): Promise<number>

  获取聊天室所有属性。

  Parameters

  • targetId: string

    聊天室会话 ID

  • Optionalcallback: IRCIMIWGetChatRoomAllEntriesCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

removeChatRoomEntry

• removeChatRoomEntry(
      targetId: string,
      key: string,
      force: boolean,
      callback?: IRCIMIWRemoveChatRoomEntryCallback,
  ): Promise<number>

  删除聊天室自定义属性。

  Parameters

  • targetId: string

    聊天室会话 ID

  • key: string

    聊天室属性键值

  • force: boolean

    是否强制删除

  • Optionalcallback: IRCIMIWRemoveChatRoomEntryCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

removeChatRoomEntries

• removeChatRoomEntries(
      targetId: string,
      keys: string[],
      force: boolean,
      callback?: IRCIMIWRemoveChatRoomEntriesCallback,
  ): Promise<number>

  批量删除聊天室自定义属性

  Parameters

  • targetId: string

    聊天室会话 ID

  • keys: string[]

    聊天室属性

  • force: boolean

    是否强制覆盖

  • Optionalcallback: IRCIMIWRemoveChatRoomEntriesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

addToBlacklist

• addToBlacklist(
      userId: string,
      callback?: IRCIMIWAddToBlacklistCallback,
  ): Promise<number>

  将某个用户加入黑名单。 当你把对方加入黑名单后，对方再发消息时，就会提示“已被加入黑名单，消息发送失败”。 但你依然可以发消息个对方。

  Parameters

  • userId: string

    用户 Id

  • Optionalcallback: IRCIMIWAddToBlacklistCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

removeFromBlacklist

• removeFromBlacklist(
      userId: string,
      callback?: IRCIMIWRemoveFromBlacklistCallback,
  ): Promise<number>

  将某个用户从黑名单中移出。

  Parameters

  • userId: string

    用户 Id

  • Optionalcallback: IRCIMIWRemoveFromBlacklistCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getBlacklistStatus

• getBlacklistStatus(
      userId: string,
      callback?: IRCIMIWGetBlacklistStatusCallback,
  ): Promise<number>

  获取某用户是否在黑名单中。

  Parameters

  • userId: string

    用户 Id

  • Optionalcallback: IRCIMIWGetBlacklistStatusCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

getBlacklist

• getBlacklist(callback?: IRCIMIWGetBlacklistCallback): Promise<number>

  获取当前用户设置的黑名单列表。

  Parameters

  • Optionalcallback: IRCIMIWGetBlacklistCallback

    事件回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

searchMessages

• searchMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      keyword: string,
      startTime: number,
      count: number,
      callback?: IRCIMIWSearchMessagesCallback,
  ): Promise<number>

  根据关键字搜索指定会话中的消息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • keyword: string

    搜索的关键字

  • startTime: number

    查询 beginTime 之前的消息， 传 0 时从最新消息开始搜索，从该时间往前搜索。

  • count: number

    查询的数量，0 < count ≤ 50。

  • Optionalcallback: IRCIMIWSearchMessagesCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

searchMessagesByTimeRange

• searchMessagesByTimeRange(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      keyword: string,
      startTime: number,
      endTime: number,
      offset: number,
      count: number,
      callback?: IRCIMIWSearchMessagesByTimeRangeCallback,
  ): Promise<number>

  根据关键字搜索指定会话中某个时间段的消息。

  Parameters

  • type: RCIMIWConversationType

    会话类型

  • targetId: string

    会话 ID

  • channelId: string

    频道 ID，仅支持超级群使用，其他会话类型传 null 即可。

  • keyword: string

    搜索的关键字

  • startTime: number

    开始时间

  • endTime: number

    结束时间

  • offset: number

    偏移量

  • count: number

    返回的搜索结果数量，0 < count ≤ 50。

  • Optionalcallback: IRCIMIWSearchMessagesByTimeRangeCallback

    事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式，预计将在 6.x 版本删除此其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

  Returns Promise<number>

  当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码