Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Methods

Constructors

constructor

Methods

_invokeMethod

  • _invokeMethod(name: string, callback: any, params?: object): any

  • Parameters

    • name: string
    • callback: any
    • Optional params: object

    Returns any

Private _setListener

  • _setListener(eventName: string, callback?: any): void

  • Parameters

    • eventName: string
    • Optional callback: any

    Returns void

addChatRoomEntries

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

    listener

    [onChatRoomEntriesAdded]

    Parameters

    • targetId: string

      聊天室会话 ID

    • entries: {}

      聊天室属性

      • [propName: string]: string
    • deleteWhenLeft: boolean

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

    • overwrite: boolean

      是否强制覆盖

    • callback: IRCIMIWAddChatRoomEntriesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

addChatRoomEntry

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

  • 设置聊天室自定义属性。

    listener

    [onChatRoomEntryAdded]

    Parameters

    • targetId: string

      聊天室会话 ID

    • key: string

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

    • value: string

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

    • deleteWhenLeft: boolean

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

    • overwrite: boolean

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

    • callback: IRCIMIWAddChatRoomEntryCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

addToBlacklist

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

    listener

    [onBlacklistAdded]

    Parameters

    • userId: string

      用户 Id

    • callback: IRCIMIWAddToBlacklistCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

cancelDownloadingMediaMessage

  • 取消下载媒体消息

    listener

    [onDownloadingMediaMessageCanceled]

    Parameters

    • message: RCIMIWMediaMessage

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

    • callback: IRCIMIWCancelDownloadingMediaMessageCallback

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

    Returns Promise<number>

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

cancelSendingMediaMessage

  • 取消发送媒体消息

    listener

    接口回调可以监听 [onSendingMediaMessageCanceled]

    Parameters

    • message: RCIMIWMediaMessage

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

    • callback: IRCIMIWCancelSendingMediaMessageCallback

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

    Returns Promise<number>

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

changeConversationNotificationLevel

  • 设置会话的消息提醒状态 注：超级群调用该接口，channelId 为空时，相当于设置了 channelId 为空的频道的免打扰，不会屏蔽整个超级群会话下所有频道的免打扰

    listener

    [onConversationNotificationLevelChanged]

    Parameters

    • type: RCIMIWConversationType

      会话类型。请注意以下限制：

      • 超级群会话类型：如在 2022.09.01 之前开通超级群业务，默认不支持为单个超级群会话所有消息设置免打扰级别（“所有消息”指所有频道中的消息和不属于任何频道的消息）。该接口仅设置指定超级群会话（targetId）中不属于任何频道的消息的免打扰状态级别。如需修改请提交工单。
      • 聊天室会话类型：不支持，因为聊天室消息默认不支持消息推送提醒。

    • targetId: string

      会话 ID

    • channelId: string

      超级群的会话频道 ID。其他类型传 null 即可。

      • 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。如果不指定频道 ID，则对所有超级群消息生效。
      • 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。

    • level: RCIMIWPushNotificationLevel

      消息通知级别

    • callback: IRCIMIWChangeConversationNotificationLevelCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changeConversationTopStatus

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

    listener

    [onConversationTopStatusChanged]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • top: boolean

      是否置顶

    • callback: IRCIMIWChangeConversationTopStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changeConversationTypeNotificationLevel

  • 设置会话类型的消息提醒状态 注：如要移除消息提醒状态，设置level为RCIMIWPushNotificationLevelDefault

    listener

    [onConversationTypeNotificationLevelChanged]

    Parameters

    Returns Promise<number>

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

changeLogLevel

  • 修改日志等级

    Parameters

    Returns Promise<number>

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

changeMessageReceiveStatus

  • 设置消息接收状态。

    listener

    [onMessageReceiveStatusChanged]

    Parameters

    • messageId: number

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

    • receivedStatus: RCIMIWReceivedStatus

      要修改的状态

    • callback: IRCIMIWChangeMessageReceivedStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changeMessageSentStatus

  • 设置消息发送状态。

    listener

    [onMessageSentStatusChanged]

    Parameters

    • messageId: number

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

    • sentStatus: RCIMIWSentStatus

      要修改的状态

    • callback: IRCIMIWChangeMessageSentStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changeNotificationQuietHours

  • 屏蔽某个时间段的消息提醒

    listener

    [onNotificationQuietHoursChanged]

    Parameters

    • startTime: string

      开始消息免打扰时间，格式为 HH:MM:SS

    • spanMinutes: number

      需要消息免打扰分钟数，0 < spanMinutes < 1440（ 比如，您设置的起始时间是 00：00， 结束时间为 01:00，则 spanMinutes 为 60 分钟。设置为 1439 代表全天免打扰 （23 60 + 59 = 1439 ））

    • level: RCIMIWPushNotificationQuietHoursLevel

      消息通知级别

    • callback: IRCIMIWChangeNotificationQuietHoursCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changePushContentShowStatus

  • 设置是否显示远程推送内容详情，此功能需要从服务端开启用户设置功能。

    listener

    [onPushContentShowStatusChanged]

    Parameters

    • showContent: boolean

      是否显示远程推送内容

    • callback: IRCIMIWChangePushContentShowStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changePushLanguage

  • 设置推送语言

    listener

    [onPushLanguageChanged]

    Parameters

    • language: string

      推送语言， 目前仅支持 en_us、zh_cn、ar_sa

    • callback: IRCIMIWChangePushLanguageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changePushReceiveStatus

  • 设置是否接收远程推送。 前提：移动端未在线，Web 、MAC/PC 终端在线，移动端是否接收远程推送。 此功能需要从服务端开启用户设置功能。

    listener

    [onPushReceiveStatusChanged]

    Parameters

    • receive: boolean

      是否接收

    • callback: IRCIMIWChangePushReceiveStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

changeUltraGroupChannelDefaultNotificationLevel

  • 设置超级群频道的默认消息状态

    listener

    [onUltraGroupChannelDefaultNotificationLevelChanged]

    Parameters

    Returns Promise<number>

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

changeUltraGroupDefaultNotificationLevel

  • 设置超级群的默认消息状态 一般由管理员设置的接口，针对超级群的所有群成员生效，针对超级群下所有频道生效，优先级较低。如果群成员自己超级群的免打扰级别，那么以群成员自己设置的为准。

    listener

    [onUltraGroupDefaultNotificationLevelChanged]

    Parameters

    Returns Promise<number>

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

clearDraftMessage

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

    listener

    [onDraftMessageCleared]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWClearDraftMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

clearMessages

  • 清除消息

    listener

    [onMessagesCleared]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    • policy: RCIMIWMessageOperationPolicy

      清除的策略

    • callback: IRCIMIWClearMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

clearUltraGroupMessages

  • 删除超级群指定时间之前的消息

    listener

    [onUltraGroupMessagesCleared]

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

      频道 ID，仅支持超级群使用。

    • timestamp: number

      时间戳

    • policy: RCIMIWMessageOperationPolicy

      清除策略

    • callback: IRCIMIWClearUltraGroupMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

clearUltraGroupMessagesForAllChannel

  • 删除超级群所有频道指定时间之前的消息

    listener

    [onUltraGroupMessagesClearedForAllChannel]

    Parameters

    • targetId: string

      会话 ID

    • timestamp: number

      时间戳

    • callback: IRCIMIWClearUltraGroupMessagesForAllChannelCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

clearUnreadCount

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

    listener

    [onUnreadCountCleared]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    • callback: IRCIMIWClearUnreadCountCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

connect

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

    listener

    接口回调可以监听 [onConnected]

    Parameters

    • token: string

      调用 server api 获取到的 token

    • timeout: number

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

    • callback: RCIMIWConnectCallback

      链接事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

createCustomMessage

  • 构建自定义消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • policy: RCIMIWCustomMessagePolicy

      消息的存储策略

    • messageIdentifier: string

      消息的标识符，需唯一

    • fields: {}

      消息的内容键值对

      • [propName: string]: string

    Returns Promise<RCIMIWCustomMessage>

    自定义消息实体

createFileMessage

  • 构建文件消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • path: string

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

    Returns Promise<RCIMIWFileMessage>

    文件消息实体

createGIFMessage

  • 构建 GIF 消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • path: string

      GIF 消息的本地路径

    Returns Promise<RCIMIWGIFMessage>

    GIF 消息实体

createImageMessage

  • 构建图片消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • path: string

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

    Returns Promise<RCIMIWImageMessage>

    图片消息实体

createLocationMessage

  • 构建位置消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • longitude: number

      经度

    • latitude: number

      纬度

    • poiName: string

      POI 信息

    • thumbnailPath: string

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

    Returns Promise<RCIMIWLocationMessage>

    位置消息实体

createReferenceMessage

  • 构建引用消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • referenceMessage: RCIMIWMessage

      引用的消息

    • text: string

      引用的文本内容

    Returns Promise<RCIMIWReferenceMessage>

    引用消息实体

createSightMessage

  • 构建小视频消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • path: string

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

    • duration: number

      小视频消息的视频时长

    Returns Promise<RCIMIWSightMessage>

    视频消息实体

createTextMessage

  • 构建文本消息

    Parameters

    • type: RCIMIWConversationType

      会话类型，

    • targetId: string

      会话 ID

    • channelId: string

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

    • text: string

      文本内容

    Returns Promise<RCIMIWTextMessage>

    文本消息实体

createVoiceMessage

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

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • path: string

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

    • duration: number

      语音消息的消息时长

    Returns Promise<RCIMIWVoiceMessage>

    语音消息的实体

deleteLocalMessages

  • 删除本地消息

    listener

    [onLocalMessagesDeleted]

    Parameters

    • messages: RCIMIWMessage[]

      消息集合

    • callback: IRCIMIWDeleteLocalMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

deleteMessages

  • 删除消息

    listener

    [onMessagesDeleted]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • messages: RCIMIWMessage[]

      消息集合

    • callback: IRCIMIWDeleteMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

destroy

  • destroy(): Promise<number>

  • 销毁 IM 对象

    Returns Promise<number>

disconnect

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

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

    Parameters

    • receivePush: boolean

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

    Returns Promise<number>

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

downloadMediaMessage

  • 下载媒体消息

    listener

    [onMediaMessageDownloaded], [onMediaMessageDownloading]

    Parameters

    Returns Promise<number>

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

getBatchRemoteUltraGroupMessages

  • 从服务获取批量消息

    listener

    [onBatchRemoteUltraGroupMessagesLoaded]

    Parameters

    Returns Promise<number>

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

getBlacklist

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

    listener

    [onBlacklistLoaded]

    Parameters

    • callback: IRCIMIWGetBlacklistCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getBlacklistStatus

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

    listener

    [onBlacklistStatusLoaded]

    Parameters

    • userId: string

      用户 Id

    • callback: IRCIMIWGetBlacklistStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getBlockedConversations

  • 获取免打扰的会话列表。

    listener

    [onBlockedConversationsLoaded]

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • callback: IRCIMIWGetBlockedConversationsCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getChatRoomAllEntries

  • 获取聊天室所有属性。

    listener

    [onChatRoomAllEntriesLoaded]

    Parameters

    • targetId: string

      聊天室会话 ID

    • callback: IRCIMIWGetChatRoomAllEntriesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getChatRoomEntry

  • 获取聊天室单个属性。

    listener

    [onChatRoomEntryLoaded]

    Parameters

    • targetId: string

      聊天室会话 ID

    • key: string

      聊天室属性键值

    • callback: IRCIMIWGetChatRoomEntryCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getChatRoomMessages

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

    listener

    [onChatRoomMessagesLoaded]

    Parameters

    • targetId: string

      聊天室会话 ID

    • timestamp: number

      起始的消息发送时间戳

    • order: RCIMIWTimeOrder

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

    • count: number

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

    • callback: IRCIMIWGetChatRoomMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getConversation

  • 获取某个会话

    listener

    [onConversationLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetConversationCallback

      获取会话事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getConversationNotificationLevel

  • 获取会话的消息提醒状态

    listener

    [onConversationNotificationLevelLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型。请注意以下限制：

      • 超级群会话类型：如在 2022.09.01 之前开通超级群业务，默认不支持为单个超级群会话所有消息设置免打扰级别（“所有消息”指所有频道中的消息和不属于任何频道的消息）。该接口仅设置指定超级群会话（targetId）中不属于任何频道的消息的免打扰状态级别。如需修改请提交工单。
      • 聊天室会话类型：不支持，因为聊天室消息默认不支持消息推送提醒。

    • targetId: string

      会话 ID

    • channelId: string

      超级群的会话频道 ID。其他类型传 null 即可。

      • 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。如果不指定频道 ID，则对所有超级群消息生效。
      • 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。

    • callback: IRCIMIWGetConversationNotificationLevelCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getConversationTopStatus

  • 获取会话的置顶状态

    listener

    [onConversationTopStatusLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetConversationTopStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getConversationTypeNotificationLevel

  • 获取会话类型的消息提醒状态

    Parameters

    Returns Promise<number>

getConversations

  • 获取某些会话

    listener

    [onConversationsLoaded]

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型

    • channelId: string

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

    • startTime: number

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

    • count: number

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

    • callback: IRCIMIWGetConversationsCallback

      获取会话列表事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getConversationsForAllChannel

  • 获取特定会话下所有频道的会话列表，只支持超级群

    listener

    [onConversationsLoadedForAllChannel]

    Parameters

    Returns Promise<number>

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

getDeltaTime

  • getDeltaTime(): Promise<number>

  • 获取本地时间与服务器时间的时间差。消息发送成功后，SDK 与服务器同步时间，消息所在数据库中存储的时间就是服务器时间。 System.currentTimeMillis() - getDeltaTime() 可以获取服务器当前时间。

    Returns Promise<number>

    本地时间与服务器时间的差值

getDraftMessage

  • 获取会话中的草稿信息。

    listener

    [onDraftMessageLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetDraftMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getFirstUnreadMessage

  • 获取第一条未读消息。

    listener

    [onFirstUnreadMessageLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetFirstUnreadMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getMessageById

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

    Parameters

    • messageId: number

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

    • callback: IRCIMIWGetMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getMessageByUId

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

    Parameters

    • messageUId: string

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

    • callback: IRCIMIWGetMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getMessageCount

  • 获取指定会话的消息总数。

    listener

    [onMessageCountLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetMessageCountCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getMessages

  • 加载历史消息

    listener

    [onMessagesLoaded]

    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

    • callback: IRCIMIWGetMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getNotificationQuietHours

  • 获取已设置的时间段消息提醒屏蔽

    listener

    [onNotificationQuietHoursLoaded]

    Parameters

    • callback: IRCIMIWGetNotificationQuietHoursCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getTopConversations

  • 根据会话类型,获取置顶会话列表

    listener

    [onTopConversationsLoaded]

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • callback: IRCIMIWGetTopConversationsCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getTotalUnreadCount

  • 获取所有未读数

    listener

    [onTotalUnreadCountLoaded]

    Parameters

    • channelId: string

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

    • callback: IRCIMIWGetTotalUnreadCountCallback

      获取所有未读数事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUltraGroupAllUnreadCount

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

    listener

    [onUltraGroupAllUnreadCountLoaded]

    Parameters

    • callback: IRCIMIWGetUltraGroupAllUnreadCountCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUltraGroupAllUnreadMentionedCount

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

    listener

    [onUltraGroupAllUnreadMentionedCountLoaded]

    Parameters

    Returns Promise<number>

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

getUltraGroupChannelDefaultNotificationLevel

  • 获取超级群频道的默认消息状态

    listener

    [onUltraGroupChannelDefaultNotificationLevelLoaded]

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

      频道 ID，仅支持超级群使用。

    • callback: IRCIMIWGetUltraGroupChannelDefaultNotificationLevelCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUltraGroupDefaultNotificationLevel

  • 获取超级群的默认消息状态

    listener

    [onUltraGroupDefaultNotificationLevelLoaded]

    Parameters

    • targetId: string

      会话 ID

    • callback: IRCIMIWGetUltraGroupDefaultNotificationLevelCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUltraGroupUnreadCount

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

    listener

    [onUltraGroupUnreadCountLoaded]

    Parameters

    • targetId: string

      会话 ID

    • callback: IRCIMIWGetUltraGroupUnreadCountCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUltraGroupUnreadMentionedCount

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

    listener

    [onUltraGroupUnreadMentionedCountLoaded]

    Parameters

    • targetId: string

      会话 ID

    • callback: IRCIMIWGetUltraGroupUnreadMentionedCountCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUnreadCount

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

    listener

    [onUnreadCountLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetUnreadCountCallback

      获取会话未读数事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUnreadCountByConversationTypes

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

    listener

    [onUnreadCountByConversationTypesLoaded]

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • contain: boolean

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

    • callback: IRCIMIWGetUnreadCountByConversationTypesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUnreadMentionedCount

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

    listener

    [onUnreadMentionedCountLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetUnreadMentionedCountCallback

      获取会话中未读的 @ 消息数量事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

getUnreadMentionedMessages

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

    listener

    [onUnreadMentionedMessagesLoaded]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWGetUnreadMentionedMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

insertMessage

  • 插入一条消息

    listener

    [onMessageInserted]

    Parameters

    • message: RCIMIWMessage

      插入的消息

    • callback: IRCIMIWInsertMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

insertMessages

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

    listener

    [onMessagesInserted]

    Parameters

    • messages: RCIMIWMessage[]

      插入的消息集合

    • callback: IRCIMIWInsertMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

joinChatRoom

  • 加入聊天室。

    listener

    [onChatRoomJoined]

    Parameters

    • targetId: string

      聊天室会话 ID

    • messageCount: number

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

    • autoCreate: boolean

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

    • callback: IRCIMIWJoinChatRoomCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

leaveChatRoom

  • 退出聊天室。

    listener

    [onChatRoomLeft]

    Parameters

    • targetId: string

      聊天室会话 ID

    • callback: IRCIMIWLeaveChatRoomCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

loadBatchRemoteUltraGroupMessages

  • loadBatchRemoteUltraGroupMessages(messages: RCIMIWMessage[]): Promise<number>

  • 从服务获取批量消息

    listener

    [onBatchRemoteUltraGroupMessagesLoaded]

    deprecated

    用 {@link #getBatchRemoteUltraGroupMessages(List, IRCIMIWGetBatchRemoteUltraGroupMessagesCallback)} 代替

    Parameters

    Returns Promise<number>

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

loadBlacklist

  • loadBlacklist(): Promise<number>

  • 加载当前用户设置的黑名单列表。

    listener

    [onBlacklistLoaded]

    deprecated

    用 {@link #getBlacklist(IRCIMIWGetBlacklistCallback)} 代替

    Returns Promise<number>

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

loadBlacklistStatus

  • loadBlacklistStatus(userId: string): Promise<number>

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

    listener

    [onBlacklistStatusLoaded]

    deprecated

    用 {@link #getBlacklistStatus(String, IRCIMIWGetBlacklistStatusCallback)} 代替

    Parameters

    • userId: string

      用户 Id

    Returns Promise<number>

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

loadBlockedConversations

  • 加载免打扰的会话列表。

    listener

    [onBlockedConversationsLoaded]

    deprecated

    用 {@link #getBlockedConversations(List, String, IRCIMIWGetBlockedConversationsCallback)} 代替

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    Returns Promise<number>

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

loadChatRoomAllEntries

  • loadChatRoomAllEntries(targetId: string): Promise<number>

  • 加载聊天室所有属性。

    listener

    [onChatRoomAllEntriesLoaded]

    deprecated

    用 {@link #getChatRoomAllEntries(String, IRCIMIWGetChatRoomAllEntriesCallback)} 代替

    Parameters

    • targetId: string

      聊天室会话 ID

    Returns Promise<number>

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

loadChatRoomEntry

  • loadChatRoomEntry(targetId: string, key: string): Promise<number>

  • 加载聊天室单个属性。

    listener

    [onChatRoomEntryLoaded]

    deprecated

    用 {@link #getChatRoomEntry(String, String, IRCIMIWGetChatRoomEntryCallback)} 代替

    Parameters

    • targetId: string

      聊天室会话 ID

    • key: string

      聊天室属性键值

    Returns Promise<number>

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

loadChatRoomMessages

  • loadChatRoomMessages(targetId: string, timestamp: number, order: RCIMIWTimeOrder, count: number): Promise<number>

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

    listener

    [onChatRoomMessagesLoaded]

    deprecated

    用 {@link #getChatRoomMessages(String, long, RCIMIWTimeOrder, int, IRCIMIWGetChatRoomMessagesCallback)} 代替

    Parameters

    • targetId: string

      聊天室会话 ID

    • timestamp: number

      起始的消息发送时间戳

    • order: RCIMIWTimeOrder

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

    • count: number

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

    Returns Promise<number>

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

loadConversation

  • 加载某个会话

    listener

    [onConversationLoaded]

    deprecated

    用 {@link #getConversation(RCIMIWConversationType, String, String, IRCIMIWGetConversationCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadConversationNotificationLevel

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

  • 加载会话的消息提醒状态

    listener

    [onConversationNotificationLevelLoaded]

    deprecated

    用 {@link #getConversationNotificationLevel(RCIMIWConversationType, String, String, IRCIMIWGetConversationNotificationLevelCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadConversationTopStatus

  • 加载会话的置顶状态

    listener

    [onConversationTopStatusLoaded]

    deprecated

    用 {@link #getConversationTopStatus(RCIMIWConversationType, String, String, IRCIMIWGetConversationTopStatusCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadConversationTypeNotificationLevel

  • 获取会话类型的消息提醒状态

    deprecated

    用 {@link #getConversationTypeNotificationLevel(RCIMIWConversationType, IRCIMIWGetConversationTypeNotificationLevelCallback)} 代替

    Parameters

    Returns Promise<number>

loadConversations

  • loadConversations(conversationTypes: RCIMIWConversationType[], channelId: string, startTime: number, count: number): Promise<number>

  • 加载某些会话

    listener

    [onConversationsLoaded]

    deprecated

    用 {@link #getConversations(List, String, long, int, IRCIMIWGetConversationsCallback)} 代替

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型

    • channelId: string

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

    • startTime: number

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

    • count: number

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

    Returns Promise<number>

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

loadConversationsForAllChannel

  • 获取特定会话下所有频道的会话列表，只支持超级群

    listener

    [onConversationsLoadedForAllChannel]

    deprecated

    用 {@link #getConversationsForAllChannel(RCIMIWConversationType, String, IRCIMIWGetConversationsForAllChannelCallback)} 代替

    Parameters

    Returns Promise<number>

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

loadDraftMessage

  • 加载会话中的草稿信息。

    listener

    [onDraftMessageLoaded]

    deprecated

    用 {@link #getDraftMessage(RCIMIWConversationType, String, String, IRCIMIWGetDraftMessageCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadFirstUnreadMessage

  • 加载第一条未读消息。

    listener

    [onFirstUnreadMessageLoaded]

    deprecated

    用 {@link #getFirstUnreadMessage(RCIMIWConversationType, String, String, IRCIMIWGetFirstUnreadMessageCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadMessageCount

  • 加载指定会话的消息总数。

    listener

    [onMessageCountLoaded]

    deprecated

    用 {@link #getMessageCount(RCIMIWConversationType, String, String, IRCIMIWGetMessageCountCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadMessages

  • 加载历史消息

    listener

    [onMessagesLoaded]

    deprecated

    用 {@link #getMessages(RCIMIWConversationType, String, String, long, RCIMIWTimeOrder, RCIMIWMessageOperationPolicy, int, IRCIMIWGetMessagesCallback)} 代替

    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

    Returns Promise<number>

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

loadNotificationQuietHours

  • loadNotificationQuietHours(): Promise<number>

  • 加载已设置的时间段消息提醒屏蔽

    listener

    [onNotificationQuietHoursLoaded]

    deprecated

    用 {@link #getNotificationQuietHours(IRCIMIWGetNotificationQuietHoursCallback)} 代替

    Returns Promise<number>

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

loadTopConversations

  • 根据会话类型,加载置顶会话列表

    listener

    [onTopConversationsLoaded]

    deprecated

    用 {@link #getTopConversations(List, String, IRCIMIWGetTopConversationsCallback)} 代替

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    Returns Promise<number>

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

loadTotalUnreadCount

  • loadTotalUnreadCount(channelId: string): Promise<number>

  • 加载所有未读数

    listener

    [onTotalUnreadCountLoaded]

    deprecated

    用 {@link #getTotalUnreadCount(String, IRCIMIWGetTotalUnreadCountCallback)} 代替

    Parameters

    • channelId: string

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

    Returns Promise<number>

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

loadUltraGroupAllUnreadCount

  • loadUltraGroupAllUnreadCount(): Promise<number>

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

    listener

    [onUltraGroupAllUnreadCountLoaded]

    deprecated

    用 {@link #getUltraGroupAllUnreadCount(IRCIMIWGetUltraGroupAllUnreadCountCallback)} 代替

    Returns Promise<number>

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

loadUltraGroupAllUnreadMentionedCount

  • loadUltraGroupAllUnreadMentionedCount(): Promise<number>

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

    listener

    [onUltraGroupAllUnreadMentionedCountLoaded]

    deprecated

    用 {@link #getUltraGroupAllUnreadMentionedCount(IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback)} 代替

    Returns Promise<number>

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

loadUltraGroupChannelDefaultNotificationLevel

  • loadUltraGroupChannelDefaultNotificationLevel(targetId: string, channelId: string): Promise<number>

  • 获取超级群频道的默认消息状态

    listener

    [onUltraGroupChannelDefaultNotificationLevelLoaded]

    deprecated

    用 {@link #getUltraGroupChannelDefaultNotificationLevel(String, String, IRCIMIWGetUltraGroupChannelDefaultNotificationLevelCallback)} 代替

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

      频道 ID，仅支持超级群使用。

    Returns Promise<number>

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

loadUltraGroupDefaultNotificationLevel

  • loadUltraGroupDefaultNotificationLevel(targetId: string): Promise<number>

  • 获取超级群的默认消息状态

    listener

    [onUltraGroupDefaultNotificationLevelLoaded]

    deprecated

    用 {@link #getUltraGroupDefaultNotificationLevel(String, IRCIMIWGetUltraGroupDefaultNotificationLevelCallback)} 代替

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadUltraGroupUnreadCount

  • loadUltraGroupUnreadCount(targetId: string): Promise<number>

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

    listener

    [onUltraGroupUnreadCountLoaded]

    deprecated

    用 {@link #getUltraGroupUnreadCount(String, IRCIMIWGetUltraGroupUnreadCountCallback)} 代替

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadUltraGroupUnreadMentionedCount

  • loadUltraGroupUnreadMentionedCount(targetId: string): Promise<number>

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

    listener

    [onUltraGroupUnreadMentionedCountLoaded]

    deprecated

    用 {@link #getUltraGroupUnreadMentionedCount(String, IRCIMIWGetUltraGroupUnreadMentionedCountCallback)} 代替

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadUnreadCount

  • 加载某个会话的未读数 注：不支持聊天室！

    listener

    [onUnreadCountLoaded]

    deprecated

    用 {@link #getUnreadCount(RCIMIWConversationType, String, String, IRCIMIWGetUnreadCountCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadUnreadCountByConversationTypes

  • loadUnreadCountByConversationTypes(conversationTypes: RCIMIWConversationType[], channelId: string, contain: boolean): Promise<number>

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

    listener

    [onUnreadCountByConversationTypesLoaded]

    deprecated

    用 {@link #getUnreadCountByConversationTypes(List, String, boolean, IRCIMIWGetUnreadCountByConversationTypesCallback)} 代替

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • contain: boolean

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

    Returns Promise<number>

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

loadUnreadMentionedCount

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

    listener

    [onUnreadMentionedCountLoaded]

    deprecated

    用 {@link #getUnreadMentionedCount(RCIMIWConversationType, String, String, IRCIMIWGetUnreadMentionedCountCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadUnreadMentionedMessages

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

  • 加载会话中未读的 @ 消息。

    listener

    [onUnreadMentionedMessagesLoaded]

    deprecated

    用 {@link #getUnreadMentionedMessages(RCIMIWConversationType, String, String, IRCIMIWGetUnreadMentionedMessagesCallback)} 代替

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

modifyUltraGroupMessage

  • 修改超级群消息

    listener

    [onUltraGroupMessageModified]

    Parameters

    • messageUId: string

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

    • message: RCIMIWMessage

      要修改的 message

    • callback: IRCIMIWModifyUltraGroupMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

recallMessage

  • 撤回消息

    listener

    [onMessageRecalled]

    Parameters

    • message: RCIMIWMessage

      需要被撤回的消息

    • callback: IRCIMIWRecallMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

recallUltraGroupMessage

  • 撤回超级群消息

    listener

    [onUltraGroupMessageRecalled]

    Parameters

    • message: RCIMIWMessage

      需要撤回的消息

    • deleteRemote: boolean

      是否删除远端消息

    • callback: IRCIMIWRecallUltraGroupMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

removeChatRoomEntries

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

    listener

    [onChatRoomEntriesRemoved]

    Parameters

    • targetId: string

      聊天室会话 ID

    • keys: string[]

      聊天室属性

    • force: boolean

      是否强制覆盖

    • callback: IRCIMIWRemoveChatRoomEntriesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

removeChatRoomEntry

  • 删除聊天室自定义属性。

    listener

    [onChatRoomEntryRemoved]

    Parameters

    • targetId: string

      聊天室会话 ID

    • key: string

      聊天室属性键值

    • force: boolean

      是否强制删除

    • callback: IRCIMIWRemoveChatRoomEntryCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

removeConversation

  • 移除某个会话

    listener

    [onConversationRemoved]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • callback: IRCIMIWRemoveConversationCallback

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

    Returns Promise<number>

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

removeConversations

  • 根据会话类型移除会话

    listener

    [onConversationsRemoved]

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • callback: IRCIMIWRemoveConversationsCallback

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

    Returns Promise<number>

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

removeFromBlacklist

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

    listener

    [onBlacklistRemoved]

    Parameters

    • userId: string

      用户 Id

    • callback: IRCIMIWRemoveFromBlacklistCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

removeMessageExpansionForKeys

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

    listener

    [onMessageExpansionForKeysRemoved]

    Parameters

    • messageUId: string

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

    • keys: string[]

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

    • callback: IRCIMIWRemoveMessageExpansionForKeysCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

removeNotificationQuietHours

  • 删除已设置的全局时间段消息提醒屏蔽

    listener

    [onNotificationQuietHoursRemoved]

    Parameters

    • callback: IRCIMIWRemoveNotificationQuietHoursCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

removeUltraGroupMessageExpansionForKeys

  • 删除超级群消息扩展信息中特定的键值对

    listener

    [onUltraGroupMessageExpansionForKeysRemoved]

    Parameters

    • messageUId: string

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

    • keys: string[]

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

    • callback: IRCIMIWRemoveUltraGroupMessageExpansionForKeysCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

saveDraftMessage

  • 保存会话草稿信息。

    listener

    [onDraftMessageSaved]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • draft: string

      草稿的文字内容。

    • callback: IRCIMIWSaveDraftMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

searchConversations

  • 根据关键字搜索会话。

    listener

    [onConversationsSearched]

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • messageTypes: RCIMIWMessageType[]

      搜索的消息类型

    • keyword: string

      搜索的关键字。

    • callback: IRCIMIWSearchConversationsCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

searchMessages

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

    listener

    [onMessagesSearched]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • keyword: string

      搜索的关键字

    • startTime: number

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

    • count: number

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

    • callback: IRCIMIWSearchMessagesCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

searchMessagesByTimeRange

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

    listener

    [onMessagesSearchedByTimeRange]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • keyword: string

      搜索的关键字

    • startTime: number

      开始时间

    • endTime: number

      结束时间

    • offset: number

      偏移量

    • count: number

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

    • callback: IRCIMIWSearchMessagesByTimeRangeCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

searchMessagesByUserId

  • 根据用户 id 搜索指定会话中的消息。

    listener

    [onMessagesSearchedByUserId]

    Parameters

    • userId: string

      用户 id

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • startTime: number

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

    • count: number

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

    • callback: IRCIMIWSearchMessagesByUserIdCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

sendGroupMessageToDesignatedUsers

  • 给指定的群成员发送消息

    listener

    [onGroupMessageToDesignatedUsersAttached], [onGroupMessageToDesignatedUsersSent]

    Parameters

    • message: RCIMIWMessage

      要发送的消息

    • userIds: string[]

      群成员集合

    • callback: RCIMIWSendGroupMessageToDesignatedUsersCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

sendGroupReadReceiptRequest

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

    listener

    [onGroupReadReceiptRequestSent]

    Parameters

    • message: RCIMIWMessage

      需要请求已读回执的消息

    • callback: IRCIMIWSendGroupReadReceiptRequestCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

sendGroupReadReceiptResponse

  • 发送群聊已读回执

    listener

    [onGroupReadReceiptResponseSent]

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • messages: RCIMIWMessage[]

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

    • callback: IRCIMIWSendGroupReadReceiptResponseCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

sendMediaMessage

  • 发送媒体消息

    listener

    接口回调可以监听 [onMediaMessageSending],[onMediaMessageAttached],[onMediaMessageSent]

    Parameters

    Returns Promise<number>

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

sendMessage

  • 发送普通消息

    listener

    接口回调可以监听 [onMessageAttached],[onMessageSent]

    Parameters

    • message: RCIMIWMessage

      发送的消息实体

    • callback: RCIMIWSendMessageCallback

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

    Returns Promise<number>

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

sendPrivateReadReceiptMessage

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

    listener

    [onPrivateReadReceiptMessageSent]

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    • callback: IRCIMIWSendPrivateReadReceiptMessageCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 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 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

sendUltraGroupTypingStatus

  • 发送超级群输入状态

    listener

    [onUltraGroupTypingStatusSent]

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

      频道 ID，仅支持超级群使用。

    • typingStatus: text

      输入状态

    • callback: IRCIMIWSendUltraGroupTypingStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

setOnBatchRemoteUltraGroupMessagesLoadedListener

setOnBlacklistAddedListener

setOnBlacklistLoadedListener

setOnBlacklistRemovedListener

setOnBlacklistStatusLoadedListener

setOnBlockedConversationsLoadedListener

setOnChatRoomAllEntriesLoadedListener

setOnChatRoomEntriesAddedListener

setOnChatRoomEntriesChangedListener

setOnChatRoomEntriesRemovedListener

setOnChatRoomEntriesSyncedListener

setOnChatRoomEntryAddedListener

setOnChatRoomEntryLoadedListener

setOnChatRoomEntryRemovedListener

setOnChatRoomJoinedListener

setOnChatRoomJoiningListener

setOnChatRoomLeftListener

setOnChatRoomMemberChangedListener

setOnChatRoomMessagesLoadedListener

setOnChatRoomStatusChangedListener

setOnConnectedListener

setOnConnectionStatusChangedListener

setOnConversationLoadedListener

setOnConversationNotificationLevelChangedListener

setOnConversationNotificationLevelLoadedListener

setOnConversationReadStatusSyncMessageReceivedListener

setOnConversationReadStatusSyncedListener

setOnConversationRemovedListener

setOnConversationTopStatusChangedListener

setOnConversationTopStatusLoadedListener

setOnConversationTopStatusSyncedListener

setOnConversationTypeNotificationLevelChangedListener

setOnConversationTypeNotificationLevelLoadedListener

setOnConversationsLoadedForAllChannelListener

setOnConversationsLoadedListener

setOnConversationsRemovedListener

setOnConversationsSearchedListener

setOnDatabaseOpenedListener

setOnDownloadingMediaMessageCanceledListener

setOnDraftMessageClearedListener

setOnDraftMessageLoadedListener

setOnDraftMessageSavedListener

setOnFirstUnreadMessageLoadedListener

setOnGroupMessageReadReceiptRequestReceivedListener

setOnGroupMessageReadReceiptResponseReceivedListener

setOnGroupMessageToDesignatedUsersAttachedListener

setOnGroupMessageToDesignatedUsersSentListener

setOnGroupReadReceiptRequestSentListener

setOnGroupReadReceiptResponseSentListener

setOnLocalMessagesDeletedListener

setOnMediaMessageAttachedListener

setOnMediaMessageDownloadedListener

setOnMediaMessageDownloadingListener

setOnMediaMessageSendingListener

setOnMediaMessageSentListener

setOnMessageAttachedListener

setOnMessageBlockedListener

setOnMessageCountLoadedListener

setOnMessageExpansionForKeysRemovedListener

setOnMessageExpansionUpdatedListener

setOnMessageInsertedListener

setOnMessageRecalledListener

setOnMessageReceiveStatusChangedListener

setOnMessageReceivedListener

setOnMessageSentListener

setOnMessageSentStatusChangedListener

setOnMessagesClearedListener

setOnMessagesDeletedListener

setOnMessagesInsertedListener

setOnMessagesLoadedListener

setOnMessagesSearchedByTimeRangeListener

setOnMessagesSearchedByUserIdListener

setOnMessagesSearchedListener

setOnNotificationQuietHoursChangedListener

setOnNotificationQuietHoursLoadedListener

setOnNotificationQuietHoursRemovedListener

setOnPrivateReadReceiptMessageSentListener

setOnPrivateReadReceiptReceivedListener

setOnPushContentShowStatusChangedListener

setOnPushLanguageChangedListener

setOnPushReceiveStatusChangedListener

setOnRemoteMessageExpansionForKeyRemovedListener

setOnRemoteMessageExpansionUpdatedListener

setOnRemoteMessageRecalledListener

setOnRemoteUltraGroupMessageExpansionUpdatedListener

setOnRemoteUltraGroupMessageModifiedListener

setOnRemoteUltraGroupMessageRecalledListener

setOnSendingMediaMessageCanceledListener

setOnTopConversationsLoadedListener

setOnTotalUnreadCountLoadedListener

setOnTypingStatusChangedListener

  • 会话输入状态发生变化。对于单聊而言，当对方正在输入时，监听会触发一次；当对方不处于输入状态时，该监听还会触发一次，但回调里输入用户列表为空。

    Parameters

    Returns void

setOnUltraGroupAllUnreadCountLoadedListener

setOnUltraGroupAllUnreadMentionedCountLoadedListener

setOnUltraGroupChannelDefaultNotificationLevelChangedListener

setOnUltraGroupChannelDefaultNotificationLevelLoadedListener

setOnUltraGroupConversationsSyncedListener

setOnUltraGroupDefaultNotificationLevelChangedListener

setOnUltraGroupDefaultNotificationLevelLoadedListener

setOnUltraGroupMessageExpansionForKeysRemovedListener

setOnUltraGroupMessageExpansionUpdatedListener

setOnUltraGroupMessageModifiedListener

setOnUltraGroupMessageRecalledListener

setOnUltraGroupMessagesClearedForAllChannelListener

setOnUltraGroupMessagesClearedListener

setOnUltraGroupReadStatusSyncedListener

setOnUltraGroupReadTimeReceivedListener

setOnUltraGroupTypingStatusChangedListener

setOnUltraGroupTypingStatusSentListener

setOnUltraGroupUnreadCountLoadedListener

setOnUltraGroupUnreadMentionedCountLoadedListener

setOnUnreadCountByConversationTypesLoadedListener

setOnUnreadCountClearedListener

setOnUnreadCountLoadedListener

setOnUnreadMentionedCountLoadedListener

setOnUnreadMentionedMessagesLoadedListener

syncConversationReadStatus

  • 同步会话阅读状态。

    listener

    [onConversationReadStatusSynced]

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    • callback: IRCIMIWSyncConversationReadStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

syncUltraGroupReadStatus

  • 上报超级群的已读时间

    listener

    [onUltraGroupReadStatusSynced]

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

      频道 ID，仅支持超级群使用。

    • timestamp: number

      已读时间

    • callback: IRCIMIWSyncUltraGroupReadStatusCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

updateMessageExpansion

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

    listener

    [onMessageExpansionUpdated]

    Parameters

    • messageUId: string

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

    • expansion: {}

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

      • [propName: string]: string
    • callback: IRCIMIWUpdateMessageExpansionCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

updateUltraGroupMessageExpansion

  • 更新超级群消息扩展信息

    listener

    [onUltraGroupMessageExpansionUpdated]

    Parameters

    • messageUId: string

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

    • expansion: {}

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

      • [propName: string]: string
    • callback: IRCIMIWUpdateUltraGroupMessageExpansionCallback

      事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

    Returns Promise<number>

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

Static _invokeMethod

  • _invokeMethod(name: string, params?: object): any

  • Parameters

    • name: string
    • Optional params: object

    Returns any

Static create

  • 初始化 IM 对象

    Parameters

    • appKey: string

      融云后台申请的应用 appKey

    • options: RCIMIWEngineOptions = {}

      全局配置项

    Returns Promise<null | default>

    创建的 IM 对象

Generated using TypeDoc