Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCIMIWEngine

Hierarchy

  • RCIMIWEngine

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static _instance

_instance: RCIMIWEngine

Methods

addChatRoomEntries

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

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

    listener

    setOnChatRoomEntriesAddedListener

    Parameters

    • targetId: string

      会话 ID

    • entries: Map<string, string>

      聊天室属性

    • deleteWhenLeft: boolean

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

    • overwrite: boolean

      是否强制覆盖

    Returns Promise<number>

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

addChatRoomEntry

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

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

    listener

    setOnChatRoomEntryAddedListener

    Parameters

    • targetId: string

      会话 ID

    • key: string

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

    • value: string

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

    • deleteWhenLeft: boolean

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

    • overwrite: boolean

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

    Returns Promise<number>

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

addToBlacklist

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

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

    listener

    setOnBlacklistAddedListener

    Parameters

    • userId: string

      用户 Id

    Returns Promise<number>

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

cancelDownloadingMediaMessage

  • 取消下载媒体消息

    listener

    setOnDownloadingMediaMessageCanceledListener

    Parameters

    Returns Promise<number>

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

cancelSendingMediaMessage

  • 取消发送媒体消息

    listener

    接口回调可以监听 setOnSendingMediaMessageCanceledListener

    Parameters

    Returns Promise<number>

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

changeConversationNotificationLevel

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

    listener

    setOnConversationNotificationLevelChangedListener

    Parameters

    Returns Promise<number>

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

changeConversationTopStatus

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

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

    listener

    setOnConversationTopStatusChangedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • top: boolean

      是否置顶

    Returns Promise<number>

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

changeConversationTypeNotificationLevel

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

    listener

    setOnConversationTypeNotificationLevelChangedListener

    Parameters

    Returns Promise<number>

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

changeLogLevel

  • 修改日志等级

    Parameters

    Returns Promise<number>

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

changeMessageReceiveStatus

  • changeMessageReceiveStatus(messageId: number, receivedStatus: RCIMIWReceivedStatus): Promise<number>
  • listener

    setOnMessageReceiveStatusChangedListener

    Parameters

    • messageId: number

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

    • receivedStatus: RCIMIWReceivedStatus

      要修改的状态

    Returns Promise<number>

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

changeMessageSentStatus

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

  • 设置消息发送状态。

    listener

    setOnMessageSentStatusChangedListener

    Parameters

    • messageId: number

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

    • sentStatus: RCIMIWSentStatus

      要修改的状态

    Returns Promise<number>

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

changeNotificationQuietHours

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

    listener

    setOnNotificationQuietHoursChangedListener

    Parameters

    • startTime: string

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

    • spanMins: number

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

    • level: RCIMIWPushNotificationQuietHoursLevel

      消息通知级别

    Returns Promise<number>

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

changePushContentShowStatus

  • changePushContentShowStatus(showContent: boolean): Promise<number>

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

    listener

    setOnPushContentShowStatusChangedListener

    Parameters

    • showContent: boolean

      是否显示远程推送内容

    Returns Promise<number>

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

changePushLanguage

  • changePushLanguage(language: string): Promise<number>

  • 设置推送语言

    listener

    setOnPushLanguageChangedListener

    Parameters

    • language: string

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

    Returns Promise<number>

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

changePushReceiveStatus

  • changePushReceiveStatus(receive: boolean): Promise<number>

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

    listener

    setOnPushReceiveStatusChangedListener

    Parameters

    • receive: boolean

      是否接收

    Returns Promise<number>

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

changeUltraGroupChannelDefaultNotificationLevel

  • changeUltraGroupChannelDefaultNotificationLevel(targetId: string, channelId: string, level: RCIMIWPushNotificationLevel): Promise<number>

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

    listener

    setOnUltraGroupChannelDefaultNotificationLevelChangedListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • level: RCIMIWPushNotificationLevel

      消息通知级别

    Returns Promise<number>

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

changeUltraGroupDefaultNotificationLevel

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

    listener

    setOnUltraGroupDefaultNotificationLevelChangedListener

    Parameters

    Returns Promise<number>

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

clearDraftMessage

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

    listener

    setOnDraftMessageClearedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

clearMessages

  • listener

    setOnMessageClearedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    • policy: RCIMIWMessageOperationPolicy

      清除的策略

    Returns Promise<number>

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

clearUltraGroupMessages

  • 删除本地特定 channel 特点时间之前的消息

    listener

    setOnUltraGroupMessagesClearedListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

      时间戳

    • policy: RCIMIWMessageOperationPolicy

      清除策略

    Returns Promise<number>

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

clearUltraGroupMessagesForAllChannel

  • clearUltraGroupMessagesForAllChannel(targetId: string, timestamp: number): Promise<number>

  • 删除本地所有 channel 特定时间之前的消息

    listener

    setOnUltraGroupMessagesClearedForAllChannelListener

    Parameters

    • targetId: string

      会话 ID

    • timestamp: number

      时间戳

    Returns Promise<number>

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

clearUnreadCount

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

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

    listener

    setOnUnreadCountClearedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    Returns Promise<number>

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

connect

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

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

    listener

    接口回调可以监听 setOnConnectedListener

    Parameters

    • token: string

      调用 server api 获取到的 token

    • timeout: number

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

    Returns Promise<number>

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

createCustomMessage

  • 构建自定义消息

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • policy: RCIMIWCustomMessagePolicy

      消息的存储策略

    • messageIdentifier: string

      消息的标识符，需唯一

    • fields: Map<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>

    图片消息实体

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

    setOnLocalMessagesDeletedListener

    Parameters

    Returns Promise<number>

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

deleteMessages

  • listener

    setOnMessagesDeletedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • messages: RCIMIWMessage[]

      消息集合

    Returns Promise<number>

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

destroy

  • destroy(): Promise<number>

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

    Returns Promise<number>

disconnect

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

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

    Parameters

    • receivePush: boolean

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

    Returns Promise<number>

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

downloadMediaMessage

getMessageById

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

    Parameters

    • messageId: number

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

    Returns Promise<RCIMIWMessage>

getMessageByUId

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

    Parameters

    • messageUId: string

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

    Returns Promise<RCIMIWMessage>

insertMessage

  • 插入一条消息

    listener

    setOnMessageInsertedListener

    Parameters

    Returns Promise<number>

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

insertMessages

  • 插入多条消息

    listener

    setOnMessagesInsertedListener

    Parameters

    Returns Promise<number>

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

joinChatRoom

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

  • 加入聊天室。

    listener

    setOnChatRoomJoinedListener

    Parameters

    • targetId: string

      会话 ID

    • messageCount: number

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

    • autoCreate: boolean

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

    Returns Promise<number>

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

leaveChatRoom

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

  • 退出聊天室。

    listener

    setOnChatRoomLeftListener

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadAllChatRoomEntries

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

  • 获取聊天室所有属性。

    listener

    setOnAllChatRoomEntriesLoadedListener

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadBatchRemoteUltraGroupMessages

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

  • 从服务获取批量消息

    listener

    setOnBatchRemoteUltraGroupMessagesLoadedListener

    Parameters

    Returns Promise<number>

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

loadBlacklist

  • loadBlacklist(): Promise<number>

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

    listener

    setOnBlacklistLoadedListener

    Returns Promise<number>

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

loadBlacklistStatus

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

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

    listener

    setOnBlacklistStatusLoadedListener

    Parameters

    • userId: string

      用户 Id

    Returns Promise<number>

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

loadBlockedConversations

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

    listener

    setOnBlockedConversationsLoadedListener

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    Returns Promise<number>

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

loadChatRoomEntry

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

  • 获取聊天室单个属性。

    listener

    setOnChatRoomEntryLoadedListener

    Parameters

    • targetId: string

      会话 ID

    • key: string

      聊天室属性键值

    Returns Promise<number>

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

loadChatRoomMessages

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

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

    listener

    setOnChatRoomMessagesLoadedListener

    Parameters

    • targetId: string

      会话 ID

    • timestamp: number

      起始的消息发送时间戳

    • order: RCIMIWTimeOrder

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

    • count: number

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

    Returns Promise<number>

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

loadConversation

  • 加载某个会话

    listener

    setOnConversationLoadedListener

    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

    setOnConversationNotificationLevelLoadedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadConversationTopStatus

  • 获取会话的置顶状态

    listener

    setOnConversationTopStatusLoadedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadConversationTypeNotificationLevel

loadConversations

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

  • 加载某些会话

    listener

    setOnConversationsLoadedListener

    Parameters

    • types: RCIMIWConversationType[]

      会话类型

    • channelId: string

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

    • startTime: number

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

    • count: number

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

    Returns Promise<number>

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

loadConversationsForAllChannel

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

    listener

    setOnConversationsLoadedForAllChannelListener

    Parameters

    Returns Promise<number>

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

loadDraftMessage

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

    listener

    setOnDraftMessageLoadedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadFirstUnreadMessage

  • 获取第一条未读消息。

    listener

    setOnFirstUnreadMessageLoadedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadMessageCount

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

    listener

    setOnMessageCountLoadedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadMessages

  • 加载历史消息

    listener

    setOnMessagesLoadedListener

    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>

  • 查询已设置的时间段消息提醒屏蔽

    Returns Promise<number>

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

loadTopConversations

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

    listener

    setOnTopConversationsLoadedListener

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    Returns Promise<number>

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

loadTotalUnreadCount

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

  • 加载所有未读数

    listener

    setOnTotalUnreadCountLoadedListener

    Parameters

    • channelId: string

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

    Returns Promise<number>

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

loadUltraGroupAllUnreadCount

  • loadUltraGroupAllUnreadCount(): Promise<number>

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

    listener

    setOnUltraGroupAllUnreadCountLoadedListener

    Returns Promise<number>

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

loadUltraGroupAllUnreadMentionedCount

  • loadUltraGroupAllUnreadMentionedCount(): Promise<number>

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

    listener

    setOnUltraGroupAllUnreadMentionedCountLoadedListener

    Returns Promise<number>

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

loadUltraGroupChannelDefaultNotificationLevel

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

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

    listener

    setOnUltraGroupChannelDefaultNotificationLevelLoadedListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

loadUltraGroupDefaultNotificationLevel

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

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

    listener

    setOnUltraGroupDefaultNotificationLevelLoadedListener

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadUltraGroupUnreadCount

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

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

    listener

    setOnUltraGroupUnreadCountLoadedListener

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadUltraGroupUnreadMentionedCount

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

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

    listener

    setOnUltraGroupUnreadMentionedCountLoadedListener

    Parameters

    • targetId: string

      会话 ID

    Returns Promise<number>

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

loadUnreadCount

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

    listener

    setOnUnreadCountLoadedListener

    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

    setOnUnreadCountByConversationTypesLoadedListener

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • contain: boolean

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

    Returns Promise<number>

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

loadUnreadMentionedCount

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

    listener

    setOnUnreadMentionedCountLoadedListener

    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

    setOnUnreadMentionedMessagesLoadedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

modifyUltraGroupMessage

  • modifyUltraGroupMessage(messageUId: string, message: RCIMIWMessage): Promise<number>

  • 修改消息

    listener

    setOnUltraGroupMessageModifiedListener

    Parameters

    • messageUId: string

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

    • message: RCIMIWMessage

      要修改的 message

    Returns Promise<number>

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

recallMessage

  • listener

    setOnMessageRecalledListener

    Parameters

    Returns Promise<number>

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

recallUltraGroupMessage

  • recallUltraGroupMessage(message: RCIMIWMessage, deleteRemote: boolean): Promise<number>

  • 撤回超级群消息

    listener

    setOnUltraGroupMessageRecalledListener

    Parameters

    • message: RCIMIWMessage

      需要撤回的消息

    • deleteRemote: boolean

      是否删除远端消息

    Returns Promise<number>

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

removeChatRoomEntries

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

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

    listener

    setOnChatRoomEntriesRemovedListener

    Parameters

    • targetId: string

      会话 ID

    • keys: string[]

      聊天室属性

    • force: boolean

      是否强制覆盖

    Returns Promise<number>

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

removeChatRoomEntry

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

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

    listener

    setOnChatRoomEntryRemovedListener

    Parameters

    • targetId: string

      会话 ID

    • key: string

      聊天室属性键值

    • force: boolean

      是否强制删除

    Returns Promise<number>

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

removeConversation

  • 移除某个会话

    listener

    setOnConversationRemovedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    Returns Promise<number>

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

removeConversations

  • 根据会话类型移除会话

    listener

    setOnConversationsRemovedListener

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    Returns Promise<number>

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

removeFromBlacklist

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

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

    listener

    setOnBlacklistRemovedListener

    Parameters

    • userId: string

      用户 Id

    Returns Promise<number>

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

removeMessageExpansionForKeys

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

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

    listener

    setOnMessageExpansionForKeysRemovedListener

    Parameters

    • messageUId: string

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

    • keys: string[]

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

    Returns Promise<number>

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

removeNotificationQuietHours

  • removeNotificationQuietHours(): Promise<number>

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

    Returns Promise<number>

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

removeUltraGroupMessageExpansion

  • removeUltraGroupMessageExpansion(messageUId: string, keys: string[]): Promise<number>

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

    listener

    setOnUltraGroupMessageExpansionRemovedListener

    Parameters

    • messageUId: string

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

    • keys: string[]

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

    Returns Promise<number>

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

saveDraftMessage

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

  • 保存会话草稿信息。

    listener

    setOnDraftMessageSavedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • draft: string

      草稿的文字内容。

    Returns Promise<number>

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

searchConversations

  • 根据关键字搜索会话。

    listener

    setOnConversationsSearchedListener

    Parameters

    • conversationTypes: RCIMIWConversationType[]

      会话类型集合

    • channelId: string

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

    • messageTypes: RCIMIWMessageType[]

      搜索的消息类型

    • keyword: string

      搜索的关键字。

    Returns Promise<number>

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

searchMessages

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

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

    listener

    setOnMessagesSearchedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • keyword: string

      搜索的关键字

    • startTime: number

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

    • count: number

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

    Returns Promise<number>

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

searchMessagesByTimeRange

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

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

    listener

    setOnMessagesSearchedByTimeRangeListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • keyword: string

      搜索的关键字

    • startTime: number

      开始时间

    • endTime: number

      结束时间

    • offset: number

      偏移量

    • count: number

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

    Returns Promise<number>

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

searchMessagesByUserId

  • searchMessagesByUserId(userId: string, type: RCIMIWConversationType, targetId: string, channelId: string, startTime: number, count: number): Promise<number>

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

    listener

    setOnMessagesSearchedByUserIdListener

    Parameters

    • userId: string

      用户 id

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • startTime: number

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

    • count: number

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

    Returns Promise<number>

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

sendGroupMessageToDesignatedUsers

  • sendGroupMessageToDesignatedUsers(message: RCIMIWMessage, userIds: string[]): Promise<number>

sendGroupReadReceiptRequest

  • sendGroupReadReceiptRequest(message: RCIMIWMessage): Promise<number>

  • 发起消息已读回执请求

    listener

    setOnGroupReadReceiptRequestSentListener

    Parameters

    Returns Promise<number>

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

sendGroupReadReceiptResponse

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

  • 发送已读回执

    listener

    setOnGroupReadReceiptResponseSentListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • messages: RCIMIWMessage[]

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

    Returns Promise<number>

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

sendMediaMessage

sendMessage

  • 发送普通消息

    listener

    接口回调可以监听 setOnMessageAttachedListener,setOnMessageSentListener

    Parameters

    Returns Promise<number>

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

sendPrivateReadReceiptMessage

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

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

    listener

    setOnPrivateReadReceiptMessageSentListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    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

  • sendUltraGroupTypingStatus(targetId: string, channelId: string, typingStatus: TEXT): Promise<number>

  • 发送超级群输入状态

    listener

    setOnUltraGroupTypingStatusSentListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • typingStatus: TEXT

    Returns Promise<number>

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

setDeviceToken

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

  • Parameters

    • deviceToken: string

    Returns Promise<number>

setOnAllChatRoomEntriesLoadedListener

  • setOnAllChatRoomEntriesLoadedListener(listener?: (code: number, targetId: string, entries: Map<string, string>) => void): void

  • loadAllChatRoomEntries 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, entries: Map<string, string>) => void
        • (code: number, targetId: string, entries: Map<string, string>): void

        • Parameters

          • code: number
          • targetId: string
          • entries: Map<string, string>

          Returns void

    Returns void

setOnBatchRemoteUltraGroupMessagesLoadedListener

  • setOnBatchRemoteUltraGroupMessagesLoadedListener(listener?: (code: number, matchedMessages: RCIMIWMessage[], notMatchedMessages: RCIMIWMessage[]) => void): void

setOnBlacklistAddedListener

  • setOnBlacklistAddedListener(listener?: (code: number, userId: string) => void): void

  • addToBlacklist 的接口监听

    Parameters

    • Optional listener: (code: number, userId: string) => void
        • (code: number, userId: string): void

        • Parameters

          • code: number
          • userId: string

          Returns void

    Returns void

setOnBlacklistLoadedListener

  • setOnBlacklistLoadedListener(listener?: (code: number, userIds: string[]) => void): void

  • loadBlacklist 的接口监听

    Parameters

    • Optional listener: (code: number, userIds: string[]) => void
        • (code: number, userIds: string[]): void

        • Parameters

          • code: number
          • userIds: string[]

          Returns void

    Returns void

setOnBlacklistRemovedListener

  • setOnBlacklistRemovedListener(listener?: (code: number, userId: string) => void): void

  • removeFromBlacklist 的接口监听

    Parameters

    • Optional listener: (code: number, userId: string) => void
        • (code: number, userId: string): void

        • Parameters

          • code: number
          • userId: string

          Returns void

    Returns void

setOnBlacklistStatusLoadedListener

  • setOnBlacklistStatusLoadedListener(listener?: (code: number, userId: string, status: RCIMIWBlacklistStatus) => void): void

setOnBlockedConversationsLoadedListener

setOnChatRoomEntriesAddedListener

  • setOnChatRoomEntriesAddedListener(listener?: (code: number, targetId: string, entries: Map<string, string>, errorEntries: Map<string, number>) => void): void

  • addChatRoomEntries 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, entries: Map<string, string>, errorEntries: Map<string, number>) => void
        • (code: number, targetId: string, entries: Map<string, string>, errorEntries: Map<string, number>): void

        • Parameters

          • code: number
          • targetId: string
          • entries: Map<string, string>
          • errorEntries: Map<string, number>

          Returns void

    Returns void

setOnChatRoomEntriesChangedListener

setOnChatRoomEntriesRemovedListener

  • setOnChatRoomEntriesRemovedListener(listener?: (code: number, targetId: string, keys: string[]) => void): void

  • removeChatRoomEntries 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, keys: string[]) => void
        • (code: number, targetId: string, keys: string[]): void

        • Parameters

          • code: number
          • targetId: string
          • keys: string[]

          Returns void

    Returns void

setOnChatRoomEntriesSyncedListener

  • setOnChatRoomEntriesSyncedListener(listener?: (roomId: string) => void): void

  • 聊天室 KV 同步完成的回调

    Parameters

    • Optional listener: (roomId: string) => void
        • (roomId: string): void

        • Parameters

          • roomId: string

          Returns void

    Returns void

setOnChatRoomEntryAddedListener

  • setOnChatRoomEntryAddedListener(listener?: (code: number, targetId: string, key: string) => void): void

  • addChatRoomEntry 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, key: string) => void
        • (code: number, targetId: string, key: string): void

        • Parameters

          • code: number
          • targetId: string
          • key: string

          Returns void

    Returns void

setOnChatRoomEntryLoadedListener

  • setOnChatRoomEntryLoadedListener(listener?: (code: number, targetId: string, entry: Map<string, string>) => void): void

  • loadChatRoomEntry 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, entry: Map<string, string>) => void
        • (code: number, targetId: string, entry: Map<string, string>): void

        • Parameters

          • code: number
          • targetId: string
          • entry: Map<string, string>

          Returns void

    Returns void

setOnChatRoomEntryRemovedListener

  • setOnChatRoomEntryRemovedListener(listener?: (code: number, targetId: string, key: string) => void): void

  • removeChatRoomEntry 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, key: string) => void
        • (code: number, targetId: string, key: string): void

        • Parameters

          • code: number
          • targetId: string
          • key: string

          Returns void

    Returns void

setOnChatRoomJoinedListener

  • setOnChatRoomJoinedListener(listener?: (code: number, targetId: string) => void): void

  • joinChatRoom 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string) => void
        • (code: number, targetId: string): void

        • Parameters

          • code: number
          • targetId: string

          Returns void

    Returns void

setOnChatRoomJoiningListener

  • setOnChatRoomJoiningListener(listener?: (targetId: string) => void): void

  • 正在加入聊天室的回调

    Parameters

    • Optional listener: (targetId: string) => void
        • (targetId: string): void

        • Parameters

          • targetId: string

          Returns void

    Returns void

setOnChatRoomLeftListener

  • setOnChatRoomLeftListener(listener?: (code: number, targetId: string) => void): void

  • leaveChatRoom 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string) => void
        • (code: number, targetId: string): void

        • Parameters

          • code: number
          • targetId: string

          Returns void

    Returns void

setOnChatRoomMemberChangedListener

setOnChatRoomMessagesLoadedListener

  • setOnChatRoomMessagesLoadedListener(listener?: (code: number, targetId: string, messages: RCIMIWMessage[], syncTime: number) => void): void

  • loadChatRoomMessages 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, messages: RCIMIWMessage[], syncTime: number) => void
        • (code: number, targetId: string, messages: RCIMIWMessage[], syncTime: number): void

        • Parameters

          • code: number
          • targetId: string
          • messages: RCIMIWMessage[]
          • syncTime: number

          Returns void

    Returns void

setOnChatRoomStatusChangedListener

  • setOnChatRoomStatusChangedListener(listener?: (targetId: string, status: RCIMIWChatRoomStatus) => void): void

setOnConnectedListener

  • setOnConnectedListener(listener?: (code: number, userId: string) => void): void

  • connect 的接口监听，收到链接结果的回调

    Parameters

    • Optional listener: (code: number, userId: string) => void
        • (code: number, userId: string): void

        • Parameters

          • code: number
          • userId: string

          Returns void

    Returns void

setOnConnectionStatusChangedListener

setOnConversationLoadedListener

setOnConversationNotificationLevelChangedListener

setOnConversationNotificationLevelLoadedListener

setOnConversationReadStatusSyncMessageReceivedListener

  • setOnConversationReadStatusSyncMessageReceivedListener(listener?: (type: RCIMIWConversationType, targetId: string, timestamp: number) => void): void

  • 同步消息未读状态监听接口。多端登录，收到其它端清除某一会话未读数通知的时候

    Parameters

    Returns void

setOnConversationReadStatusSyncedListener

  • setOnConversationReadStatusSyncedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number) => void): void

setOnConversationRemovedListener

  • setOnConversationRemovedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string) => void): void

setOnConversationTopStatusChangedListener

  • setOnConversationTopStatusChangedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, top: boolean) => void): void

setOnConversationTopStatusLoadedListener

  • setOnConversationTopStatusLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, top: boolean) => void): void

setOnConversationTopStatusSyncedListener

  • setOnConversationTopStatusSyncedListener(listener?: (type: RCIMIWConversationType, targetId: string, channelId: string, top: boolean) => void): void

  • 会话状态置顶多端同步监听

    Parameters

    Returns void

setOnConversationTypeNotificationLevelChangedListener

setOnConversationTypeNotificationLevelLoadedListener

setOnConversationsLoadedForAllChannelListener

setOnConversationsLoadedListener

  • setOnConversationsLoadedListener(listener?: (code: number, conversationTypes: RCIMIWConversationType[], channelId: string, startTime: number, count: number, conversations: RCIMIWConversation[]) => void): void

setOnConversationsRemovedListener

  • setOnConversationsRemovedListener(listener?: (code: number, types: RCIMIWConversationType[], channelId: string) => void): void

setOnConversationsSearchedListener

setOnDatabaseOpenedListener

  • setOnDatabaseOpenedListener(listener?: (code: number) => void): void

  • connect 的接口监听，数据库打开时发生的回调

    Parameters

    • Optional listener: (code: number) => void
        • (code: number): void

        • Parameters

          • code: number

          Returns void

    Returns void

setOnDownloadingMediaMessageCanceledListener

  • setOnDownloadingMediaMessageCanceledListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void

setOnDraftMessageClearedListener

  • setOnDraftMessageClearedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string) => void): void

setOnDraftMessageLoadedListener

  • setOnDraftMessageLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, draft: string) => void): void

  • loadDraftMessage 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, draft: string) => void

    Returns void

setOnDraftMessageSavedListener

  • setOnDraftMessageSavedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, draft: string) => void): void

  • saveDraftMessage 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, draft: string) => void

    Returns void

setOnFirstUnreadMessageLoadedListener

setOnGroupMessageReadReceiptRequestReceivedListener

  • setOnGroupMessageReadReceiptRequestReceivedListener(listener?: (targetId: string, messageUId: string) => void): void

  • 收到群聊已读回执请求的监听

    Parameters

    • Optional listener: (targetId: string, messageUId: string) => void
        • (targetId: string, messageUId: string): void

        • Parameters

          • targetId: string
          • messageUId: string

          Returns void

    Returns void

setOnGroupMessageReadReceiptResponseReceivedListener

  • setOnGroupMessageReadReceiptResponseReceivedListener(listener?: (targetId: string, messageUId: string, respondUserIds: Map<string, number>) => void): void

  • 收到群聊已读回执响应的监听

    Parameters

    • Optional listener: (targetId: string, messageUId: string, respondUserIds: Map<string, number>) => void
        • (targetId: string, messageUId: string, respondUserIds: Map<string, number>): void

        • Parameters

          • targetId: string
          • messageUId: string
          • respondUserIds: Map<string, number>

          Returns void

    Returns void

setOnGroupMessageToDesignatedUsersAttachedListener

  • setOnGroupMessageToDesignatedUsersAttachedListener(listener?: (message: RCIMIWMessage) => void): void

setOnGroupMessageToDesignatedUsersSentListener

  • setOnGroupMessageToDesignatedUsersSentListener(listener?: (code: number, message: RCIMIWMessage) => void): void

setOnGroupReadReceiptRequestSentListener

  • setOnGroupReadReceiptRequestSentListener(listener?: (code: number, message: RCIMIWMessage) => void): void

  • sendGroupReadReceiptRequest 的接口监听

    Parameters

    Returns void

setOnGroupReadReceiptResponseSentListener

  • setOnGroupReadReceiptResponseSentListener(listener?: (code: number, targetId: string, channelId: string, messages: RCIMIWMessage[]) => void): void

  • sendGroupReadReceiptResponse 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, channelId: string, messages: RCIMIWMessage[]) => void
        • (code: number, targetId: string, channelId: string, messages: RCIMIWMessage[]): void

        • Parameters

          • code: number
          • targetId: string
          • channelId: string
          • messages: RCIMIWMessage[]

          Returns void

    Returns void

setOnLocalMessagesDeletedListener

  • setOnLocalMessagesDeletedListener(listener?: (code: number, messages: RCIMIWMessage[]) => void): void

setOnMediaMessageAttachedListener

setOnMediaMessageDownloadedListener

  • setOnMediaMessageDownloadedListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void

setOnMediaMessageDownloadingListener

  • setOnMediaMessageDownloadingListener(listener?: (message: RCIMIWMediaMessage, progress: number) => void): void

setOnMediaMessageSendingListener

  • setOnMediaMessageSendingListener(listener?: (message: RCIMIWMediaMessage, progress: number) => void): void

setOnMediaMessageSentListener

  • setOnMediaMessageSentListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void

setOnMessageAttachedListener

  • setOnMessageAttachedListener(listener?: (message: RCIMIWMessage) => void): void

setOnMessageBlockedListener

setOnMessageClearedListener

  • setOnMessageClearedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number) => void): void

  • clearMessages 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number) => void

    Returns void

setOnMessageCountLoadedListener

  • setOnMessageCountLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void): void

  • loadMessageCount 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void

    Returns void

setOnMessageExpansionForKeysRemovedListener

  • setOnMessageExpansionForKeysRemovedListener(listener?: (code: number, messageUId: string, keys: string[]) => void): void

  • removeMessageExpansionForKeys 的接口监听

    Parameters

    • Optional listener: (code: number, messageUId: string, keys: string[]) => void
        • (code: number, messageUId: string, keys: string[]): void

        • Parameters

          • code: number
          • messageUId: string
          • keys: string[]

          Returns void

    Returns void

setOnMessageExpansionUpdatedListener

  • setOnMessageExpansionUpdatedListener(listener?: (code: number, messageUId: string, expansion: Map<string, string>) => void): void

  • updateMessageExpansion 的接口监听

    Parameters

    • Optional listener: (code: number, messageUId: string, expansion: Map<string, string>) => void
        • (code: number, messageUId: string, expansion: Map<string, string>): void

        • Parameters

          • code: number
          • messageUId: string
          • expansion: Map<string, string>

          Returns void

    Returns void

setOnMessageInsertedListener

  • setOnMessageInsertedListener(listener?: (code: number, message: RCIMIWMessage) => void): void

setOnMessageRecalledListener

  • setOnMessageRecalledListener(listener?: (code: number, message: RCIMIWMessage) => void): void

setOnMessageReceiveStatusChangedListener

  • setOnMessageReceiveStatusChangedListener(listener?: (code: number, messageId: number) => void): void

  • changeMessageReceiveStatus 的接口监听

    Parameters

    • Optional listener: (code: number, messageId: number) => void
        • (code: number, messageId: number): void

        • Parameters

          • code: number
          • messageId: number

          Returns void

    Returns void

setOnMessageReceivedListener

  • setOnMessageReceivedListener(listener?: (message: RCIMIWMessage, left: number, offline: boolean, hasPackage: boolean) => void): void

  • 收到消息的监听

    Parameters

    • Optional listener: (message: RCIMIWMessage, left: number, offline: boolean, hasPackage: boolean) => void
        • (message: RCIMIWMessage, left: number, offline: boolean, hasPackage: boolean): void

        • Parameters

          • message: RCIMIWMessage
          • left: number
          • offline: boolean
          • hasPackage: boolean

          Returns void

    Returns void

setOnMessageSentListener

  • setOnMessageSentListener(listener?: (code: number, message: RCIMIWMessage) => void): void

setOnMessageSentStatusChangedListener

  • setOnMessageSentStatusChangedListener(listener?: (code: number, messageId: number) => void): void

  • changeMessageSentStatus 的接口监听

    Parameters

    • Optional listener: (code: number, messageId: number) => void
        • (code: number, messageId: number): void

        • Parameters

          • code: number
          • messageId: number

          Returns void

    Returns void

setOnMessagesDeletedListener

setOnMessagesInsertedListener

  • setOnMessagesInsertedListener(listener?: (code: number, messages: RCIMIWMessage[]) => void): void

setOnMessagesLoadedListener

setOnMessagesSearchedByTimeRangeListener

  • setOnMessagesSearchedByTimeRangeListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, keyword: string, startTime: number, endTime: number, offset: number, count: number, messages: RCIMIWMessage[]) => void): void

  • searchMessagesByTimeRange 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, keyword: string, startTime: number, endTime: number, offset: number, count: number, messages: RCIMIWMessage[]) => void
        • (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, keyword: string, startTime: number, endTime: number, offset: number, count: number, messages: RCIMIWMessage[]): void

        • Parameters

          Returns void

    Returns void

setOnMessagesSearchedByUserIdListener

  • setOnMessagesSearchedByUserIdListener(listener?: (code: number, userId: string, type: RCIMIWConversationType, targetId: string, channelId: string, startTime: number, count: number, messages: RCIMIWMessage[]) => void): void

setOnMessagesSearchedListener

  • setOnMessagesSearchedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, keyword: string, startTime: number, count: number, messages: RCIMIWMessage[]) => void): void

  • searchMessages 的接口监听

    Parameters

    Returns void

setOnNotificationQuietHoursChangedListener

setOnNotificationQuietHoursLoadedListener

setOnNotificationQuietHoursRemovedListener

  • setOnNotificationQuietHoursRemovedListener(listener?: (code: number) => void): void

  • removeNotificationQuietHours 的接口回调

    Parameters

    • Optional listener: (code: number) => void
        • (code: number): void

        • Parameters

          • code: number

          Returns void

    Returns void

setOnPrivateReadReceiptMessageSentListener

  • setOnPrivateReadReceiptMessageSentListener(listener?: (code: number, targetId: string, channelId: string, timestamp: number) => void): void

  • sendPrivateReadReceiptMessage 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, channelId: string, timestamp: number) => void
        • (code: number, targetId: string, channelId: string, timestamp: number): void

        • Parameters

          • code: number
          • targetId: string
          • channelId: string
          • timestamp: number

          Returns void

    Returns void

setOnPrivateReadReceiptReceivedListener

  • setOnPrivateReadReceiptReceivedListener(listener?: (targetId: string, channelId: string, timestamp: number) => void): void

  • 单聊中收到消息回执的回调。

    Parameters

    • Optional listener: (targetId: string, channelId: string, timestamp: number) => void
        • (targetId: string, channelId: string, timestamp: number): void

        • Parameters

          • targetId: string
          • channelId: string
          • timestamp: number

          Returns void

    Returns void

setOnPushContentShowStatusChangedListener

  • setOnPushContentShowStatusChangedListener(listener?: (code: number, showContent: boolean) => void): void

  • changePushContentShowStatus 的接口监听

    Parameters

    • Optional listener: (code: number, showContent: boolean) => void
        • (code: number, showContent: boolean): void

        • Parameters

          • code: number
          • showContent: boolean

          Returns void

    Returns void

setOnPushLanguageChangedListener

  • setOnPushLanguageChangedListener(listener?: (code: number, language: string) => void): void

  • changePushLanguage 的接口监听

    Parameters

    • Optional listener: (code: number, language: string) => void
        • (code: number, language: string): void

        • Parameters

          • code: number
          • language: string

          Returns void

    Returns void

setOnPushReceiveStatusChangedListener

  • setOnPushReceiveStatusChangedListener(listener?: (code: number, receive: boolean) => void): void

  • changePushReceiveStatus 的接口监听

    Parameters

    • Optional listener: (code: number, receive: boolean) => void
        • (code: number, receive: boolean): void

        • Parameters

          • code: number
          • receive: boolean

          Returns void

    Returns void

setOnRemoteMessageExpansionForKeyRemovedListener

  • setOnRemoteMessageExpansionForKeyRemovedListener(listener?: (message: RCIMIWMessage, keys: string[]) => void): void

  • 消息扩展信息删除的回调

    Parameters

    Returns void

setOnRemoteMessageExpansionUpdatedListener

  • setOnRemoteMessageExpansionUpdatedListener(listener?: (expansion: Map<string, string>, message: RCIMIWMessage) => void): void

  • 消息扩展信息更改的回调

    Parameters

    • Optional listener: (expansion: Map<string, string>, message: RCIMIWMessage) => void

        • Parameters

          Returns void

    Returns void

setOnRemoteMessageRecalledListener

  • setOnRemoteMessageRecalledListener(listener?: (message: RCIMIWMessage) => void): void

  • 撤回消息监听器

    Parameters

    Returns void

setOnRemoteUltraGroupMessageExpansionUpdatedListener

  • setOnRemoteUltraGroupMessageExpansionUpdatedListener(listener?: (messages: RCIMIWMessage[]) => void): void

  • 超级群消息 kv 被更新

    Parameters

    Returns void

setOnRemoteUltraGroupMessageModifiedListener

  • setOnRemoteUltraGroupMessageModifiedListener(listener?: (messages: RCIMIWMessage[]) => void): void

  • 超级群消息被更改

    Parameters

    Returns void

setOnRemoteUltraGroupMessageRecalledListener

  • setOnRemoteUltraGroupMessageRecalledListener(listener?: (messages: RCIMIWMessage[]) => void): void

  • 超级群消息被撤回

    Parameters

    Returns void

setOnSendingMediaMessageCanceledListener

  • setOnSendingMediaMessageCanceledListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void

setOnTopConversationsLoadedListener

setOnTotalUnreadCountLoadedListener

  • setOnTotalUnreadCountLoadedListener(listener?: (code: number, channelId: string, count: number) => void): void

  • loadTotalUnreadCount 的接口监听

    Parameters

    • Optional listener: (code: number, channelId: string, count: number) => void
        • (code: number, channelId: string, count: number): void

        • Parameters

          • code: number
          • channelId: string
          • count: number

          Returns void

    Returns void

setOnTypingStatusChangedListener

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

    Parameters

    Returns void

setOnUltraGroupAllUnreadCountLoadedListener

  • setOnUltraGroupAllUnreadCountLoadedListener(listener?: (code: number, count: number) => void): void

  • loadUltraGroupAllUnreadMentionedCount 的接口监听

    Parameters

    • Optional listener: (code: number, count: number) => void
        • (code: number, count: number): void

        • Parameters

          • code: number
          • count: number

          Returns void

    Returns void

setOnUltraGroupAllUnreadMentionedCountLoadedListener

  • setOnUltraGroupAllUnreadMentionedCountLoadedListener(listener?: (code: number, count: number) => void): void

  • loadUltraGroupAllUnreadMentionedCount 的接口监听

    Parameters

    • Optional listener: (code: number, count: number) => void
        • (code: number, count: number): void

        • Parameters

          • code: number
          • count: number

          Returns void

    Returns void

setOnUltraGroupChannelDefaultNotificationLevelChangedListener

  • setOnUltraGroupChannelDefaultNotificationLevelChangedListener(listener?: (code: number, targetId: string, channelId: string, level: RCIMIWPushNotificationLevel) => void): void

setOnUltraGroupChannelDefaultNotificationLevelLoadedListener

  • setOnUltraGroupChannelDefaultNotificationLevelLoadedListener(listener?: (code: number, targetId: string, channelId: string, level: RCIMIWPushNotificationLevel) => void): void

setOnUltraGroupDefaultNotificationLevelChangedListener

  • setOnUltraGroupDefaultNotificationLevelChangedListener(listener?: (code: number, targetId: string, level: RCIMIWPushNotificationLevel) => void): void

setOnUltraGroupDefaultNotificationLevelLoadedListener

  • setOnUltraGroupDefaultNotificationLevelLoadedListener(listener?: (code: number, targetId: string, level: RCIMIWPushNotificationLevel) => void): void

setOnUltraGroupMessageExpansionRemovedListener

  • setOnUltraGroupMessageExpansionRemovedListener(listener?: (code: number, messageUId: string, keys: string[]) => void): void

  • removeUltraGroupMessageExpansion 的接口监听

    Parameters

    • Optional listener: (code: number, messageUId: string, keys: string[]) => void
        • (code: number, messageUId: string, keys: string[]): void

        • Parameters

          • code: number
          • messageUId: string
          • keys: string[]

          Returns void

    Returns void

setOnUltraGroupMessageExpansionUpdatedListener

  • setOnUltraGroupMessageExpansionUpdatedListener(listener?: (code: number, expansion: Map<string, string>, messageUId: string) => void): void

  • updateUltraGroupMessageExpansion 的接口监听

    Parameters

    • Optional listener: (code: number, expansion: Map<string, string>, messageUId: string) => void
        • (code: number, expansion: Map<string, string>, messageUId: string): void

        • Parameters

          • code: number
          • expansion: Map<string, string>
          • messageUId: string

          Returns void

    Returns void

setOnUltraGroupMessageModifiedListener

  • setOnUltraGroupMessageModifiedListener(listener?: (code: number, messageUId: string) => void): void

  • modifyUltraGroupMessage 的接口监听

    Parameters

    • Optional listener: (code: number, messageUId: string) => void
        • (code: number, messageUId: string): void

        • Parameters

          • code: number
          • messageUId: string

          Returns void

    Returns void

setOnUltraGroupMessageRecalledListener

  • setOnUltraGroupMessageRecalledListener(listener?: (code: number, message: RCIMIWMessage, deleteRemote: boolean) => void): void

  • recallUltraGroupMessage 的接口监听

    Parameters

    • Optional listener: (code: number, message: RCIMIWMessage, deleteRemote: boolean) => void
        • (code: number, message: RCIMIWMessage, deleteRemote: boolean): void

        • Parameters

          Returns void

    Returns void

setOnUltraGroupMessagesClearedForAllChannelListener

  • setOnUltraGroupMessagesClearedForAllChannelListener(listener?: (code: number, targetId: string, timestamp: number) => void): void

  • clearUltraGroupMessagesForAllChannel 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, timestamp: number) => void
        • (code: number, targetId: string, timestamp: number): void

        • Parameters

          • code: number
          • targetId: string
          • timestamp: number

          Returns void

    Returns void

setOnUltraGroupMessagesClearedListener

  • setOnUltraGroupMessagesClearedListener(listener?: (code: number, targetId: string, channelId: string, timestamp: number, policy: RCIMIWMessageOperationPolicy) => void): void

setOnUltraGroupReadStatusSyncedListener

  • setOnUltraGroupReadStatusSyncedListener(listener?: (code: number, targetId: string, channelId: string, timestamp: number) => void): void

  • syncUltraGroupReadStatus 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, channelId: string, timestamp: number) => void
        • (code: number, targetId: string, channelId: string, timestamp: number): void

        • Parameters

          • code: number
          • targetId: string
          • channelId: string
          • timestamp: number

          Returns void

    Returns void

setOnUltraGroupReadTimeReceivedListener

  • setOnUltraGroupReadTimeReceivedListener(listener?: (targetId: string, channelId: string, timestamp: number) => void): void

  • 超级群已读的监听

    Parameters

    • Optional listener: (targetId: string, channelId: string, timestamp: number) => void
        • (targetId: string, channelId: string, timestamp: number): void

        • Parameters

          • targetId: string
          • channelId: string
          • timestamp: number

          Returns void

    Returns void

setOnUltraGroupTypingStatusChangedListener

setOnUltraGroupTypingStatusSentListener

  • setOnUltraGroupTypingStatusSentListener(listener?: (code: number, targetId: string, channelId: string, typingStatus: TEXT) => void): void

  • sendUltraGroupTypingStatus 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, channelId: string, typingStatus: TEXT) => void
        • (code: number, targetId: string, channelId: string, typingStatus: TEXT): void

        • Parameters

          • code: number
          • targetId: string
          • channelId: string
          • typingStatus: TEXT

          Returns void

    Returns void

setOnUltraGroupUnreadCountLoadedListener

  • setOnUltraGroupUnreadCountLoadedListener(listener?: (code: number, targetId: string, count: number) => void): void

  • Parameters

    • Optional listener: (code: number, targetId: string, count: number) => void
        • (code: number, targetId: string, count: number): void

        • Parameters

          • code: number
          • targetId: string
          • count: number

          Returns void

    Returns void

setOnUltraGroupUnreadMentionedCountLoadedListener

  • setOnUltraGroupUnreadMentionedCountLoadedListener(listener?: (code: number, targetId: string, count: number) => void): void

  • loadUltraGroupUnreadMentionedCount 的接口监听

    Parameters

    • Optional listener: (code: number, targetId: string, count: number) => void
        • (code: number, targetId: string, count: number): void

        • Parameters

          • code: number
          • targetId: string
          • count: number

          Returns void

    Returns void

setOnUnreadCountByConversationTypesLoadedListener

  • setOnUnreadCountByConversationTypesLoadedListener(listener?: (code: number, types: RCIMIWConversationType[], channelId: string, contain: boolean, count: number) => void): void

setOnUnreadCountClearedListener

  • setOnUnreadCountClearedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number) => void): void

  • clearUnreadCount 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, timestamp: number) => void

    Returns void

setOnUnreadCountLoadedListener

  • setOnUnreadCountLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void): void

  • loadUnreadCount 的接口监听

    Parameters

    • Optional listener: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void

    Returns void

setOnUnreadMentionedCountLoadedListener

  • setOnUnreadMentionedCountLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, count: number) => void): void

setOnUnreadMentionedMessagesLoadedListener

  • setOnUnreadMentionedMessagesLoadedListener(listener?: (code: number, type: RCIMIWConversationType, targetId: string, channelId: string, messages: RCIMIWMessage[]) => void): void

syncConversationReadStatus

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

  • 同步会话阅读状态。

    listener

    setOnConversationReadStatusSyncedListener

    Parameters

    • type: RCIMIWConversationType

      会话类型

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

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

    Returns Promise<number>

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

syncUltraGroupReadStatus

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

  • 上报超级群的已读时间

    listener

    setOnUltraGroupReadStatusSyncedListener

    Parameters

    • targetId: string

      会话 ID

    • channelId: string

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

    • timestamp: number

      已读时间

    Returns Promise<number>

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

updateMessageExpansion

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

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

    listener

    setOnMessageExpansionUpdatedListener

    Parameters

    • messageUId: string

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

    • expansion: Map<string, string>

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

    Returns Promise<number>

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

updateUltraGroupMessageExpansion

  • updateUltraGroupMessageExpansion(messageUId: string, expansion: Map<string, string>): Promise<number>

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

    listener

    setOnUltraGroupMessageExpansionUpdatedListener

    Parameters

    • messageUId: string

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

    • expansion: Map<string, string>

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

    Returns Promise<number>

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

Static create

  • 创建接口引擎

    Parameters

    • appKey: string

      开发者后台获取的 AppKey

    • options: RCIMIWEngineOptions = {}

      引擎配置项

    Returns RCIMIWEngine

    引擎实例

Generated using TypeDoc