interface IRCIMIWListener {
    onMessageReceived?: (
        message: RCIMIWMessage,
        left: number,
        offline: boolean,
        hasPackage: boolean,
    ) => void;
    onConnectionStatusChanged?: (status: RCIMIWConnectionStatus) => void;
    onConversationTopStatusSynced?: (
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        top: boolean,
    ) => void;
    onConversationNotificationLevelSynced?: (
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onRemoteMessageRecalled?: (message: RCIMIWMessage) => void;
    onPrivateReadReceiptReceived?: (
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onRemoteMessageExpansionUpdated?: (
        expansion: Map<string, string>,
        message: RCIMIWMessage,
    ) => void;
    onRemoteMessageExpansionForKeyRemoved?: (
        message: RCIMIWMessage,
        keys: string[],
    ) => void;
    onChatRoomMemberChanged?: (
        targetId: string,
        actions: RCIMIWChatRoomMemberAction[],
    ) => void;
    onTypingStatusChanged?: (
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        userTypingStatus: RCIMIWTypingStatus[],
    ) => void;
    onConversationReadStatusSyncMessageReceived?: (
        type: RCIMIWConversationType,
        targetId: string,
        timestamp: number,
    ) => void;
    onChatRoomEntriesSynced?: (roomId: string) => void;
    onChatRoomEntriesChanged?: (
        operationType: RCIMIWChatRoomEntriesOperationType,
        roomId: string,
        entries: Map<string, string>,
    ) => void;
    onRemoteUltraGroupMessageExpansionUpdated?: (
        messages: RCIMIWMessage[],
    ) => void;
    onRemoteUltraGroupMessageModified?: (messages: RCIMIWMessage[]) => void;
    onRemoteUltraGroupMessageRecalled?: (messages: RCIMIWMessage[]) => void;
    onUltraGroupReadTimeReceived?: (
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onUltraGroupTypingStatusChanged?: (
        info: RCIMIWUltraGroupTypingStatusInfo[],
    ) => void;
    onMessageBlocked?: (info: RCIMIWBlockedMessageInfo) => void;
    onChatRoomStatusChanged?: (
        targetId: string,
        status: RCIMIWChatRoomStatus,
    ) => void;
    onGroupMessageReadReceiptRequestReceived?: (
        targetId: string,
        messageUId: string,
    ) => void;
    onGroupMessageReadReceiptResponseReceived?: (
        targetId: string,
        messageUId: string,
        respondUserIds: Map<string, number>,
    ) => void;
    onConnected?: (code: number, userId: string) => void;
    onDatabaseOpened?: (code: number) => void;
    onConversationLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        conversation: RCIMIWConversation,
    ) => void;
    onConversationsLoaded?: (
        code: number,
        conversationTypes: RCIMIWConversationType[],
        channelId: string,
        startTime: number,
        count: number,
        conversations: RCIMIWConversation[],
    ) => void;
    onConversationRemoved?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
    ) => void;
    onConversationsRemoved?: (
        code: number,
        conversationTypes: RCIMIWConversationType[],
        channelId: string,
    ) => void;
    onTotalUnreadCountLoaded?: (
        code: number,
        channelId: string,
        count: number,
    ) => void;
    onUnreadCountLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        count: number,
    ) => void;
    onUnreadCountByConversationTypesLoaded?: (
        code: number,
        conversationTypes: RCIMIWConversationType[],
        channelId: string,
        contain: boolean,
        count: number,
    ) => void;
    onUnreadMentionedCountLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        count: number,
    ) => void;
    onUltraGroupAllUnreadCountLoaded?: (code: number, count: number) => void;
    onUltraGroupAllUnreadMentionedCountLoaded?: (
        code: number,
        count: number,
    ) => void;
    onUltraGroupConversationsSynced?: () => void;
    onUnreadCountCleared?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onDraftMessageSaved?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        draft: string,
    ) => void;
    onDraftMessageCleared?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
    ) => void;
    onDraftMessageLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        draft: string,
    ) => void;
    onBlockedConversationsLoaded?: (
        code: number,
        conversationTypes: RCIMIWConversationType[],
        channelId: string,
        conversations: RCIMIWConversation[],
    ) => void;
    onConversationTopStatusChanged?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        top: boolean,
    ) => void;
    onConversationTopStatusLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        top: boolean,
    ) => void;
    onConversationReadStatusSynced?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onMessageAttached?: (message: RCIMIWMessage) => void;
    onMessageSent?: (code: number, message: RCIMIWMessage) => void;
    onMediaMessageAttached?: (message: RCIMIWMediaMessage) => void;
    onMediaMessageSending?: (
        message: RCIMIWMediaMessage,
        progress: number,
    ) => void;
    onSendingMediaMessageCanceled?: (
        code: number,
        message: RCIMIWMediaMessage,
    ) => void;
    onMediaMessageSent?: (code: number, message: RCIMIWMediaMessage) => void;
    onMediaMessageDownloading?: (
        message: RCIMIWMediaMessage,
        progress: number,
    ) => void;
    onMediaMessageDownloaded?: (
        code: number,
        message: RCIMIWMediaMessage,
    ) => void;
    onDownloadingMediaMessageCanceled?: (
        code: number,
        message: RCIMIWMediaMessage,
    ) => void;
    onMessagesLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        sentTime: number,
        order: RCIMIWTimeOrder,
        messages: RCIMIWMessage[],
    ) => void;
    onUnreadMentionedMessagesLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        messages: RCIMIWMessage[],
    ) => void;
    onFirstUnreadMessageLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        message: RCIMIWMessage,
    ) => void;
    onMessageInserted?: (code: number, message: RCIMIWMessage) => void;
    onMessagesInserted?: (code: number, messages: RCIMIWMessage[]) => void;
    onMessagesCleared?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onLocalMessagesDeleted?: (code: number, messages: RCIMIWMessage[]) => void;
    onMessagesDeleted?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        messages: RCIMIWMessage[],
    ) => void;
    onMessageRecalled?: (code: number, message: RCIMIWMessage) => void;
    onPrivateReadReceiptMessageSent?: (
        code: number,
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onMessageExpansionUpdated?: (
        code: number,
        messageUId: string,
        expansion: Map<string, string>,
    ) => void;
    onMessageExpansionForKeysRemoved?: (
        code: number,
        messageUId: string,
        keys: string[],
    ) => void;
    onMessageReceiveStatusChanged?: (code: number, messageId: number) => void;
    onMessageSentStatusChanged?: (code: number, messageId: number) => void;
    onChatRoomJoined?: (code: number, targetId: string) => void;
    onChatRoomJoining?: (targetId: string) => void;
    onChatRoomLeft?: (code: number, targetId: string) => void;
    onChatRoomMessagesLoaded?: (
        code: number,
        targetId: string,
        messages: RCIMIWMessage[],
        syncTime: number,
    ) => void;
    onChatRoomEntryAdded?: (
        code: number,
        targetId: string,
        key: string,
    ) => void;
    onChatRoomEntriesAdded?: (
        code: number,
        targetId: string,
        entries: Map<string, string>,
        errorEntries: Map<string, number>,
    ) => void;
    onChatRoomEntryLoaded?: (
        code: number,
        targetId: string,
        entry: Map<string, string>,
    ) => void;
    onChatRoomAllEntriesLoaded?: (
        code: number,
        targetId: string,
        entries: Map<string, string>,
    ) => void;
    onChatRoomEntryRemoved?: (
        code: number,
        targetId: string,
        key: string,
    ) => void;
    onChatRoomEntriesRemoved?: (
        code: number,
        targetId: string,
        keys: string[],
    ) => void;
    onBlacklistAdded?: (code: number, userId: string) => void;
    onBlacklistRemoved?: (code: number, userId: string) => void;
    onBlacklistStatusLoaded?: (
        code: number,
        userId: string,
        status: RCIMIWBlacklistStatus,
    ) => void;
    onBlacklistLoaded?: (code: number, userIds: string[]) => void;
    onMessagesSearched?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        keyword: string,
        startTime: number,
        count: number,
        messages: RCIMIWMessage[],
    ) => void;
    onMessagesSearchedByTimeRange?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        keyword: string,
        startTime: number,
        endTime: number,
        offset: number,
        count: number,
        messages: RCIMIWMessage[],
    ) => void;
    onMessagesSearchedByUserId?: (
        code: number,
        userId: string,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        startTime: number,
        count: number,
        messages: RCIMIWMessage[],
    ) => void;
    onConversationsSearched?: (
        code: number,
        conversationTypes: RCIMIWConversationType[],
        channelId: string,
        messageTypes: RCIMIWMessageType[],
        keyword: string,
        conversations: RCIMIWSearchConversationResult[],
    ) => void;
    onGroupReadReceiptRequestSent?: (
        code: number,
        message: RCIMIWMessage,
    ) => void;
    onGroupReadReceiptResponseSent?: (
        code: number,
        targetId: string,
        channelId: string,
        messages: RCIMIWMessage[],
    ) => void;
    onNotificationQuietHoursChanged?: (
        code: number,
        startTime: string,
        spanMinutes: number,
        level: RCIMIWPushNotificationQuietHoursLevel,
    ) => void;
    onNotificationQuietHoursRemoved?: (code: number) => void;
    onNotificationQuietHoursLoaded?: (
        code: number,
        startTime: string,
        spanMinutes: number,
        level: RCIMIWPushNotificationQuietHoursLevel,
    ) => void;
    onConversationNotificationLevelChanged?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onConversationNotificationLevelLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onConversationTypeNotificationLevelChanged?: (
        code: number,
        type: RCIMIWConversationType,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onConversationTypeNotificationLevelLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onUltraGroupDefaultNotificationLevelChanged?: (
        code: number,
        targetId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onUltraGroupDefaultNotificationLevelLoaded?: (
        code: number,
        targetId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onUltraGroupChannelDefaultNotificationLevelChanged?: (
        code: number,
        targetId: string,
        channelId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onUltraGroupChannelDefaultNotificationLevelLoaded?: (
        code: number,
        targetId: string,
        channelId: string,
        level: RCIMIWPushNotificationLevel,
    ) => void;
    onPushContentShowStatusChanged?: (
        code: number,
        showContent: boolean,
    ) => void;
    onPushLanguageChanged?: (code: number, language: string) => void;
    onPushReceiveStatusChanged?: (code: number, receive: boolean) => void;
    onMessageCountLoaded?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        channelId: string,
        count: number,
    ) => void;
    onTopConversationsLoaded?: (
        code: number,
        conversationTypes: RCIMIWConversationType[],
        channelId: string,
        conversations: RCIMIWConversation[],
    ) => void;
    onGroupMessageToDesignatedUsersAttached?: (message: RCIMIWMessage) => void;
    onGroupMessageToDesignatedUsersSent?: (
        code: number,
        message: RCIMIWMessage,
    ) => void;
    onUltraGroupReadStatusSynced?: (
        code: number,
        targetId: string,
        channelId: string,
        timestamp: number,
    ) => void;
    onConversationsLoadedForAllChannel?: (
        code: number,
        type: RCIMIWConversationType,
        targetId: string,
        conversations: RCIMIWConversation[],
    ) => void;
    onUltraGroupUnreadMentionedCountLoaded?: (
        code: number,
        targetId: string,
        count: number,
    ) => void;
    onUltraGroupUnreadCountLoaded?: (
        code: number,
        targetId: string,
        count: number,
    ) => void;
    onUltraGroupMessageModified?: (code: number, messageUId: string) => void;
    onUltraGroupMessageRecalled?: (
        code: number,
        message: RCIMIWMessage,
        deleteRemote: boolean,
    ) => void;
    onUltraGroupMessagesCleared?: (
        code: number,
        targetId: string,
        channelId: string,
        timestamp: number,
        policy: RCIMIWMessageOperationPolicy,
    ) => void;
    onUltraGroupMessagesClearedForAllChannel?: (
        code: number,
        targetId: string,
        timestamp: number,
    ) => void;
    onUltraGroupTypingStatusSent?: (
        code: number,
        targetId: string,
        channelId: string,
        typingStatus: TEXT,
    ) => void;
    onBatchRemoteUltraGroupMessagesLoaded?: (
        code: number,
        matchedMessages: RCIMIWMessage[],
        notMatchedMessages: RCIMIWMessage[],
    ) => void;
    onUltraGroupMessageExpansionUpdated?: (
        code: number,
        expansion: Map<string, string>,
        messageUId: string,
    ) => void;
    onUltraGroupMessageExpansionForKeysRemoved?: (
        code: number,
        messageUId: string,
        keys: string[],
    ) => void;
}

Properties

onMessageReceived? onConnectionStatusChanged? onConversationTopStatusSynced? onConversationNotificationLevelSynced? onRemoteMessageRecalled? onPrivateReadReceiptReceived? onRemoteMessageExpansionUpdated? onRemoteMessageExpansionForKeyRemoved? onChatRoomMemberChanged? onTypingStatusChanged? onConversationReadStatusSyncMessageReceived? onChatRoomEntriesSynced? onChatRoomEntriesChanged? onRemoteUltraGroupMessageExpansionUpdated? onRemoteUltraGroupMessageModified? onRemoteUltraGroupMessageRecalled? onUltraGroupReadTimeReceived? onUltraGroupTypingStatusChanged? onMessageBlocked? onChatRoomStatusChanged? onGroupMessageReadReceiptRequestReceived? onGroupMessageReadReceiptResponseReceived? onConnected? onDatabaseOpened? onConversationLoaded? onConversationsLoaded? onConversationRemoved? onConversationsRemoved? onTotalUnreadCountLoaded? onUnreadCountLoaded? onUnreadCountByConversationTypesLoaded? onUnreadMentionedCountLoaded? onUltraGroupAllUnreadCountLoaded? onUltraGroupAllUnreadMentionedCountLoaded? onUltraGroupConversationsSynced? onUnreadCountCleared? onDraftMessageSaved? onDraftMessageCleared? onDraftMessageLoaded? onBlockedConversationsLoaded? onConversationTopStatusChanged? onConversationTopStatusLoaded? onConversationReadStatusSynced? onMessageAttached? onMessageSent? onMediaMessageAttached? onMediaMessageSending? onSendingMediaMessageCanceled? onMediaMessageSent? onMediaMessageDownloading? onMediaMessageDownloaded? onDownloadingMediaMessageCanceled? onMessagesLoaded? onUnreadMentionedMessagesLoaded? onFirstUnreadMessageLoaded? onMessageInserted? onMessagesInserted? onMessagesCleared? onLocalMessagesDeleted? onMessagesDeleted? onMessageRecalled? onPrivateReadReceiptMessageSent? onMessageExpansionUpdated? onMessageExpansionForKeysRemoved? onMessageReceiveStatusChanged? onMessageSentStatusChanged? onChatRoomJoined? onChatRoomJoining? onChatRoomLeft? onChatRoomMessagesLoaded? onChatRoomEntryAdded? onChatRoomEntriesAdded? onChatRoomEntryLoaded? onChatRoomAllEntriesLoaded? onChatRoomEntryRemoved? onChatRoomEntriesRemoved? onBlacklistAdded? onBlacklistRemoved? onBlacklistStatusLoaded? onBlacklistLoaded? onMessagesSearched? onMessagesSearchedByTimeRange? onMessagesSearchedByUserId? onConversationsSearched? onGroupReadReceiptRequestSent? onGroupReadReceiptResponseSent? onNotificationQuietHoursChanged? onNotificationQuietHoursRemoved? onNotificationQuietHoursLoaded? onConversationNotificationLevelChanged? onConversationNotificationLevelLoaded? onConversationTypeNotificationLevelChanged? onConversationTypeNotificationLevelLoaded? onUltraGroupDefaultNotificationLevelChanged? onUltraGroupDefaultNotificationLevelLoaded? onUltraGroupChannelDefaultNotificationLevelChanged? onUltraGroupChannelDefaultNotificationLevelLoaded? onPushContentShowStatusChanged? onPushLanguageChanged? onPushReceiveStatusChanged? onMessageCountLoaded? onTopConversationsLoaded? onGroupMessageToDesignatedUsersAttached? onGroupMessageToDesignatedUsersSent? onUltraGroupReadStatusSynced? onConversationsLoadedForAllChannel? onUltraGroupUnreadMentionedCountLoaded? onUltraGroupUnreadCountLoaded? onUltraGroupMessageModified? onUltraGroupMessageRecalled? onUltraGroupMessagesCleared? onUltraGroupMessagesClearedForAllChannel? onUltraGroupTypingStatusSent? onBatchRemoteUltraGroupMessagesLoaded? onUltraGroupMessageExpansionUpdated? onUltraGroupMessageExpansionForKeysRemoved?

Properties

onMessageReceived?: (
    message: RCIMIWMessage,
    left: number,
    offline: boolean,
    hasPackage: boolean,
) => void

收到消息的监听

Type declaration

    • (
          message: RCIMIWMessage,
          left: number,
          offline: boolean,
          hasPackage: boolean,
      ): void
    • Parameters

      • message: RCIMIWMessage

        接收到的消息对象

      • left: number

        当客户端连接成功后,服务端会将所有补偿消息以消息包的形式下发给客户端,最多每 200 条消息为一个消息包,即一个 Package, 客户端接受到消息包后,会逐条解析并通知应用。left 为当前消息包(Package)里还剩余的消息条数

      • offline: boolean

        消息是否离线消息

      • hasPackage: boolean

        是否在服务端还存在未下发的消息包

      Returns void

onConnectionStatusChanged?: (status: RCIMIWConnectionStatus) => void

网络状态变化

Type declaration

onConversationTopStatusSynced?: (
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    top: boolean,
) => void

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

Type declaration

    • (
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          top: boolean,
      ): void
    • Parameters

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • top: boolean

        是否置顶

      Returns void

onConversationNotificationLevelSynced?: (
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    level: RCIMIWPushNotificationLevel,
) => void

会话状态免打扰多端同步监听

Type declaration

onRemoteMessageRecalled?: (message: RCIMIWMessage) => void

撤回消息监听器

Type declaration

onPrivateReadReceiptReceived?: (
    targetId: string,
    channelId: string,
    timestamp: number,
) => void

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

Type declaration

    • (targetId: string, channelId: string, timestamp: number): void
    • Parameters

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

        已阅读的最后一条消息的 sendTime

      Returns void

onRemoteMessageExpansionUpdated?: (
    expansion: Map<string, string>,
    message: RCIMIWMessage,
) => void

消息扩展信息更改的回调

Type declaration

    • (expansion: Map<string, string>, message: RCIMIWMessage): void
    • Parameters

      • expansion: Map<string, string>

        消息扩展信息中更新的键值对,只包含更新的键值对,不是全部的数据。如果想获取全部的键值对,请使用 message 的 expansion 属性。

      • message: RCIMIWMessage

        发生变化的消息

      Returns void

onRemoteMessageExpansionForKeyRemoved?: (
    message: RCIMIWMessage,
    keys: string[],
) => void

消息扩展信息删除的回调

Type declaration

    • (message: RCIMIWMessage, keys: string[]): void
    • Parameters

      • message: RCIMIWMessage

        发生变化的消息

      • keys: string[]

        消息扩展信息中删除的键值对 key 列表

      Returns void

onChatRoomMemberChanged?: (
    targetId: string,
    actions: RCIMIWChatRoomMemberAction[],
) => void

聊天室用户进入、退出聊天室监听

Type declaration

onTypingStatusChanged?: (
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    userTypingStatus: RCIMIWTypingStatus[],
) => void

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

Type declaration

onConversationReadStatusSyncMessageReceived?: (
    type: RCIMIWConversationType,
    targetId: string,
    timestamp: number,
) => void

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

Type declaration

onChatRoomEntriesSynced?: (roomId: string) => void

聊天室 KV 同步完成的回调

Type declaration

    • (roomId: string): void
    • Parameters

      • roomId: string

        聊天室 ID

      Returns void

onChatRoomEntriesChanged?: (
    operationType: RCIMIWChatRoomEntriesOperationType,
    roomId: string,
    entries: Map<string, string>,
) => void

聊天室 KV 发生变化的回调

Type declaration

onRemoteUltraGroupMessageExpansionUpdated?: (messages: RCIMIWMessage[]) => void

超级群消息 kv 被更新

Type declaration

onRemoteUltraGroupMessageModified?: (messages: RCIMIWMessage[]) => void

超级群消息被更改

Type declaration

onRemoteUltraGroupMessageRecalled?: (messages: RCIMIWMessage[]) => void

超级群消息被撤回

Type declaration

onUltraGroupReadTimeReceived?: (
    targetId: string,
    channelId: string,
    timestamp: number,
) => void

超级群已读的监听

Type declaration

    • (targetId: string, channelId: string, timestamp: number): void
    • Parameters

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

      Returns void

onUltraGroupTypingStatusChanged?: (
    info: RCIMIWUltraGroupTypingStatusInfo[],
) => void

用户输入状态变化的回调 当客户端收到用户输入状态的变化时,会回调此接口,通知发生变化的会话以及当前正在输入的RCUltraGroupTypingStatusInfo列表

Type declaration

onMessageBlocked?: (info: RCIMIWBlockedMessageInfo) => void

发送含有敏感词消息被拦截的回调

Type declaration

onChatRoomStatusChanged?: (
    targetId: string,
    status: RCIMIWChatRoomStatus,
) => void

聊天室状态发生变化的监听

Type declaration

onGroupMessageReadReceiptRequestReceived?: (
    targetId: string,
    messageUId: string,
) => void

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

Type declaration

    • (targetId: string, messageUId: string): void
    • Parameters

      • targetId: string

        会话 ID

      • messageUId: string

        消息的 messageUid

      Returns void

onGroupMessageReadReceiptResponseReceived?: (
    targetId: string,
    messageUId: string,
    respondUserIds: Map<string, number>,
) => void

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

Type declaration

    • (
          targetId: string,
          messageUId: string,
          respondUserIds: Map<string, number>,
      ): void
    • Parameters

      • targetId: string

        会话 ID

      • messageUId: string

        收到回执响应的消息的 messageUId

      • respondUserIds: Map<string, number>

        会话中响应了此消息的用户列表。其中 key: 用户 id ; value: 响应时间。

      Returns void

onConnected?: (code: number, userId: string) => void

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

Type declaration

    • (code: number, userId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • userId: string

        链接成功的用户 ID

      Returns void

onDatabaseOpened?: (code: number) => void

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

Type declaration

    • (code: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      Returns void

onConversationLoaded?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    conversation: RCIMIWConversation,
) => void

loadConversation 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          conversation: RCIMIWConversation,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • conversation: RCIMIWConversation

        获取到的会话

      Returns void

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

loadConversations 的接口监听

Type declaration

    • (
          code: number,
          conversationTypes: RCIMIWConversationType[],
          channelId: string,
          startTime: number,
          count: number,
          conversations: RCIMIWConversation[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • conversationTypes: RCIMIWConversationType[]

        会话类型集合

      • channelId: string

        频道 ID,仅支持超级群使用,

      • startTime: number

        时间戳(毫秒)

      • count: number

        查询的数量

      • conversations: RCIMIWConversation[]

        查询到的会话集合

      Returns void

onConversationRemoved?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
) => void

removeConversation 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      Returns void

onConversationsRemoved?: (
    code: number,
    conversationTypes: RCIMIWConversationType[],
    channelId: string,
) => void

removeConversations 的接口监听

Type declaration

    • (
          code: number,
          conversationTypes: RCIMIWConversationType[],
          channelId: string,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • conversationTypes: RCIMIWConversationType[]

        会话类型集合

      • channelId: string

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

      Returns void

onTotalUnreadCountLoaded?: (
    code: number,
    channelId: string,
    count: number,
) => void

loadTotalUnreadCount 的接口监听

Type declaration

    • (code: number, channelId: string, count: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • channelId: string

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

      • count: number

        未读数量

      Returns void

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

loadUnreadCount 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          count: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • count: number

        未读数量

      Returns void

onUnreadCountByConversationTypesLoaded?: (
    code: number,
    conversationTypes: RCIMIWConversationType[],
    channelId: string,
    contain: boolean,
    count: number,
) => void

loadUnreadCountByConversationTypes 的接口监听

Type declaration

    • (
          code: number,
          conversationTypes: RCIMIWConversationType[],
          channelId: string,
          contain: boolean,
          count: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • conversationTypes: RCIMIWConversationType[]

        会话类型集合

      • channelId: string

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

      • contain: boolean

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

      • count: number

        未读数量

      Returns void

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

loadUnreadMentionedCount 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          count: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • count: number

        未读数量

      Returns void

onUltraGroupAllUnreadCountLoaded?: (code: number, count: number) => void

loadUltraGroupAllUnreadMentionedCount 的接口监听

Type declaration

    • (code: number, count: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • count: number

        未读数量

      Returns void

onUltraGroupAllUnreadMentionedCountLoaded?: (
    code: number,
    count: number,
) => void

loadUltraGroupAllUnreadMentionedCount 的接口监听

Type declaration

    • (code: number, count: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • count: number

        未读数量

      Returns void

onUltraGroupConversationsSynced?: () => void

超级群列表同步完成的回调

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

clearUnreadCount 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          timestamp: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

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

      Returns void

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

saveDraftMessage 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          draft: string,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • draft: string

        草稿信息

      Returns void

onDraftMessageCleared?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
) => void

clearDraftMessage 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      Returns void

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

loadDraftMessage 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          draft: string,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常 接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • draft: string

        草稿信息

      Returns void

onBlockedConversationsLoaded?: (
    code: number,
    conversationTypes: RCIMIWConversationType[],
    channelId: string,
    conversations: RCIMIWConversation[],
) => void

loadBlockedConversations 的接口监听

Type declaration

    • (
          code: number,
          conversationTypes: RCIMIWConversationType[],
          channelId: string,
          conversations: RCIMIWConversation[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • conversationTypes: RCIMIWConversationType[]

        会话类型集合

      • channelId: string

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

      • conversations: RCIMIWConversation[]

        获取到的会话集合

      Returns void

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

changeConversationTopStatus 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          top: boolean,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • top: boolean

        是否置顶

      Returns void

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

loadConversationTopStatus 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          top: boolean,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • top: boolean

        是否置顶

      Returns void

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

syncConversationReadStatus 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          timestamp: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

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

      Returns void

onMessageAttached?: (message: RCIMIWMessage) => void

sendMessage 的接口监听

Type declaration

onMessageSent?: (code: number, message: RCIMIWMessage) => void

sendMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMessage

        发送的消息

      Returns void

onMediaMessageAttached?: (message: RCIMIWMediaMessage) => void

sendMediaMessage 的接口监听

Type declaration

onMediaMessageSending?: (message: RCIMIWMediaMessage, progress: number) => void

sendMediaMessage 的接口监听

Type declaration

onSendingMediaMessageCanceled?: (
    code: number,
    message: RCIMIWMediaMessage,
) => void

cancelSendingMediaMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMediaMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMediaMessage

        发送的消息

      Returns void

onMediaMessageSent?: (code: number, message: RCIMIWMediaMessage) => void

sendMediaMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMediaMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMediaMessage

        发送的消息

      Returns void

onMediaMessageDownloading?: (
    message: RCIMIWMediaMessage,
    progress: number,
) => void

downloadMediaMessage 的接口监听

Type declaration

onMediaMessageDownloaded?: (code: number, message: RCIMIWMediaMessage) => void

downloadMediaMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMediaMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMediaMessage

        下载的消息

      Returns void

onDownloadingMediaMessageCanceled?: (
    code: number,
    message: RCIMIWMediaMessage,
) => void

cancelDownloadingMediaMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMediaMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMediaMessage

        取消下载的消息

      Returns void

onMessagesLoaded?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    sentTime: number,
    order: RCIMIWTimeOrder,
    messages: RCIMIWMessage[],
) => void

loadMessages 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          sentTime: number,
          order: RCIMIWTimeOrder,
          messages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • sentTime: number

        当前消息时间戳

      • order: RCIMIWTimeOrder

        获取消息的方向。BEFORE:获取 sentTime 之前的消息 (时间递减),AFTER:获取 sentTime 之后的消息 (时间递增)

      • messages: RCIMIWMessage[]

        获取到的消息集合

      Returns void

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

loadUnreadMentionedMessages 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          messages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • messages: RCIMIWMessage[]

        获取到的消息集合

      Returns void

onFirstUnreadMessageLoaded?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    message: RCIMIWMessage,
) => void

loadFirstUnreadMessage 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          message: RCIMIWMessage,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • message: RCIMIWMessage

        获取到的消息

      Returns void

onMessageInserted?: (code: number, message: RCIMIWMessage) => void

insertMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMessage

        插入的消息

      Returns void

onMessagesInserted?: (code: number, messages: RCIMIWMessage[]) => void

insertMessages 的接口监听

Type declaration

    • (code: number, messages: RCIMIWMessage[]): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messages: RCIMIWMessage[]

        插入的消息集合

      Returns void

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

clearMessages 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          timestamp: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

        时间戳

      Returns void

onLocalMessagesDeleted?: (code: number, messages: RCIMIWMessage[]) => void

deleteLocalMessages 的接口监听

Type declaration

    • (code: number, messages: RCIMIWMessage[]): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messages: RCIMIWMessage[]

        删除的消息集合

      Returns void

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

deleteMessages 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          messages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • messages: RCIMIWMessage[]

        删除的消息集合

      Returns void

onMessageRecalled?: (code: number, message: RCIMIWMessage) => void

recallMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMessage

        撤回的消息

      Returns void

onPrivateReadReceiptMessageSent?: (
    code: number,
    targetId: string,
    channelId: string,
    timestamp: number,
) => void

sendPrivateReadReceiptMessage 的接口监听

Type declaration

    • (code: number, targetId: string, channelId: string, timestamp: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

        时间戳

      Returns void

onMessageExpansionUpdated?: (
    code: number,
    messageUId: string,
    expansion: Map<string, string>,
) => void

updateMessageExpansion 的接口监听

Type declaration

    • (code: number, messageUId: string, expansion: Map<string, string>): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messageUId: string

        消息的 messageUid

      • expansion: Map<string, string>

        要更新的消息扩展信息键值对,类型是 HashMap

      Returns void

onMessageExpansionForKeysRemoved?: (
    code: number,
    messageUId: string,
    keys: string[],
) => void

removeMessageExpansionForKeys 的接口监听

Type declaration

    • (code: number, messageUId: string, keys: string[]): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messageUId: string

        消息的 messageUid

      • keys: string[]

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

      Returns void

onMessageReceiveStatusChanged?: (code: number, messageId: number) => void

changeMessageReceiveStatus 的接口监听

Type declaration

    • (code: number, messageId: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messageId: number

        消息的 messageId

      Returns void

onMessageSentStatusChanged?: (code: number, messageId: number) => void

changeMessageSentStatus 的接口监听

Type declaration

    • (code: number, messageId: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messageId: number

        消息的 messageId

      Returns void

onChatRoomJoined?: (code: number, targetId: string) => void

joinChatRoom 的接口监听

Type declaration

    • (code: number, targetId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      Returns void

onChatRoomJoining?: (targetId: string) => void

正在加入聊天室的回调

Type declaration

    • (targetId: string): void
    • Parameters

      • targetId: string

        聊天室 ID

      Returns void

onChatRoomLeft?: (code: number, targetId: string) => void

leaveChatRoom 的接口监听

Type declaration

    • (code: number, targetId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      Returns void

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

loadChatRoomMessages 的接口监听

Type declaration

    • (
          code: number,
          targetId: string,
          messages: RCIMIWMessage[],
          syncTime: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • messages: RCIMIWMessage[]

        加载到的消息

      • syncTime: number

        下次拉取的时间戳

      Returns void

onChatRoomEntryAdded?: (code: number, targetId: string, key: string) => void

addChatRoomEntry 的接口监听

Type declaration

    • (code: number, targetId: string, key: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • key: string

        聊天室属性名称

      Returns void

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

addChatRoomEntries 的接口监听

Type declaration

    • (
          code: number,
          targetId: string,
          entries: Map<string, string>,
          errorEntries: Map<string, number>,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • entries: Map<string, string>

        聊天室属性

      • errorEntries: Map<string, number>

        发生错误的属性

      Returns void

onChatRoomEntryLoaded?: (
    code: number,
    targetId: string,
    entry: Map<string, string>,
) => void

loadChatRoomEntry 的接口监听

Type declaration

    • (code: number, targetId: string, entry: Map<string, string>): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • entry: Map<string, string>

        获取到的属性。

      Returns void

onChatRoomAllEntriesLoaded?: (
    code: number,
    targetId: string,
    entries: Map<string, string>,
) => void

loadChatRoomAllEntries 的接口监听

Type declaration

    • (code: number, targetId: string, entries: Map<string, string>): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • entries: Map<string, string>

        获取到的属性集合。

      Returns void

onChatRoomEntryRemoved?: (code: number, targetId: string, key: string) => void

removeChatRoomEntry 的接口监听

Type declaration

    • (code: number, targetId: string, key: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • key: string

        聊天室属性键值

      Returns void

onChatRoomEntriesRemoved?: (
    code: number,
    targetId: string,
    keys: string[],
) => void

removeChatRoomEntries 的接口监听

Type declaration

    • (code: number, targetId: string, keys: string[]): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • keys: string[]

        聊天室属性键值集合

      Returns void

onBlacklistAdded?: (code: number, userId: string) => void

addToBlacklist 的接口监听

Type declaration

    • (code: number, userId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • userId: string

        用户 ID

      Returns void

onBlacklistRemoved?: (code: number, userId: string) => void

removeFromBlacklist 的接口监听

Type declaration

    • (code: number, userId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • userId: string

        用户 ID

      Returns void

onBlacklistStatusLoaded?: (
    code: number,
    userId: string,
    status: RCIMIWBlacklistStatus,
) => void

loadBlacklistStatus 的接口监听

Type declaration

    • (code: number, userId: string, status: RCIMIWBlacklistStatus): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • userId: string

        用户 ID

      • status: RCIMIWBlacklistStatus

        当前状态

      Returns void

onBlacklistLoaded?: (code: number, userIds: string[]) => void

loadBlacklist 的接口监听

Type declaration

    • (code: number, userIds: string[]): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • userIds: string[]

        用户 ID 集合

      Returns void

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

searchMessages 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          keyword: string,
          startTime: number,
          count: number,
          messages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • keyword: string

        搜索的关键字

      • startTime: number

        查询 beginTime 之前的消息

      • count: number

        查询的数量

      • messages: RCIMIWMessage[]

        查询到的消息集合

      Returns void

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

searchMessagesByTimeRange 的接口监听

Type declaration

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

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • keyword: string

        搜索的关键字

      • startTime: number

        开始时间

      • endTime: number

        结束时间

      • offset: number

        偏移量

      • count: number

        查询的数量

      • messages: RCIMIWMessage[]

        查询到的消息集合

      Returns void

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

searchMessagesByUserId 的接口监听

Type declaration

    • (
          code: number,
          userId: string,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          startTime: number,
          count: number,
          messages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • userId: string

        用户 id

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • startTime: number

        查询记录的起始时间

      • count: number

        查询的数量

      • messages: RCIMIWMessage[]

        查询到的消息集合

      Returns void

onConversationsSearched?: (
    code: number,
    conversationTypes: RCIMIWConversationType[],
    channelId: string,
    messageTypes: RCIMIWMessageType[],
    keyword: string,
    conversations: RCIMIWSearchConversationResult[],
) => void

searchConversations 的接口监听

Type declaration

onGroupReadReceiptRequestSent?: (code: number, message: RCIMIWMessage) => void

sendGroupReadReceiptRequest 的接口监听

Type declaration

    • (code: number, message: RCIMIWMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMessage

        需要请求已读回执的消息

      Returns void

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

sendGroupReadReceiptResponse 的接口监听

Type declaration

    • (
          code: number,
          targetId: string,
          channelId: string,
          messages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • messages: RCIMIWMessage[]

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

      Returns void

onNotificationQuietHoursChanged?: (
    code: number,
    startTime: string,
    spanMinutes: number,
    level: RCIMIWPushNotificationQuietHoursLevel,
) => void

changeNotificationQuietHours 的接口回调

Type declaration

    • (
          code: number,
          startTime: string,
          spanMinutes: number,
          level: RCIMIWPushNotificationQuietHoursLevel,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • startTime: string

        开始消息免打扰时间

      • spanMinutes: number

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

      • level: RCIMIWPushNotificationQuietHoursLevel

        消息通知级别

      Returns void

onNotificationQuietHoursRemoved?: (code: number) => void

removeNotificationQuietHours 的接口回调

Type declaration

    • (code: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      Returns void

onNotificationQuietHoursLoaded?: (
    code: number,
    startTime: string,
    spanMinutes: number,
    level: RCIMIWPushNotificationQuietHoursLevel,
) => void

loadNotificationQuietHours 的接口回调

Type declaration

    • (
          code: number,
          startTime: string,
          spanMinutes: number,
          level: RCIMIWPushNotificationQuietHoursLevel,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • startTime: string

        开始消息免打扰时间

      • spanMinutes: number

        已设置的屏蔽时间分钟数,0 < spanMinutes < 1440

      • level: RCIMIWPushNotificationQuietHoursLevel

        消息通知级别

      Returns void

onConversationNotificationLevelChanged?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    level: RCIMIWPushNotificationLevel,
) => void

changeConversationNotificationLevel 的接口回调

Type declaration

onConversationNotificationLevelLoaded?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    channelId: string,
    level: RCIMIWPushNotificationLevel,
) => void

loadConversationNotificationLevel 的接口回调

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          level: RCIMIWPushNotificationLevel,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • level: RCIMIWPushNotificationLevel

        当前会话的消息通知级别

      Returns void

onConversationTypeNotificationLevelChanged?: (
    code: number,
    type: RCIMIWConversationType,
    level: RCIMIWPushNotificationLevel,
) => void

changeConversationTypeNotificationLevel 的接口回调

Type declaration

onConversationTypeNotificationLevelLoaded?: (
    code: number,
    type: RCIMIWConversationType,
    level: RCIMIWPushNotificationLevel,
) => void

loadConversationTypeNotificationLevel 的接口回调

Type declaration

onUltraGroupDefaultNotificationLevelChanged?: (
    code: number,
    targetId: string,
    level: RCIMIWPushNotificationLevel,
) => void

changeUltraGroupDefaultNotificationLevel 的接口回调

Type declaration

onUltraGroupDefaultNotificationLevelLoaded?: (
    code: number,
    targetId: string,
    level: RCIMIWPushNotificationLevel,
) => void

loadUltraGroupDefaultNotificationLevel 的接口回调

Type declaration

onUltraGroupChannelDefaultNotificationLevelChanged?: (
    code: number,
    targetId: string,
    channelId: string,
    level: RCIMIWPushNotificationLevel,
) => void

changeUltraGroupChannelDefaultNotificationLevel 的接口回调

Type declaration

    • (
          code: number,
          targetId: string,
          channelId: string,
          level: RCIMIWPushNotificationLevel,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • level: RCIMIWPushNotificationLevel

        消息通知级别

      Returns void

onUltraGroupChannelDefaultNotificationLevelLoaded?: (
    code: number,
    targetId: string,
    channelId: string,
    level: RCIMIWPushNotificationLevel,
) => void

loadUltraGroupChannelDefaultNotificationLevel 的接口回调

Type declaration

    • (
          code: number,
          targetId: string,
          channelId: string,
          level: RCIMIWPushNotificationLevel,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • level: RCIMIWPushNotificationLevel

        消息通知级别

      Returns void

onPushContentShowStatusChanged?: (code: number, showContent: boolean) => void

changePushContentShowStatus 的接口监听

Type declaration

    • (code: number, showContent: boolean): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • showContent: boolean

        是否显示远程推送内容

      Returns void

onPushLanguageChanged?: (code: number, language: string) => void

changePushLanguage 的接口监听

Type declaration

    • (code: number, language: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • language: string

        推送语言

      Returns void

onPushReceiveStatusChanged?: (code: number, receive: boolean) => void

changePushReceiveStatus 的接口监听

Type declaration

    • (code: number, receive: boolean): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • receive: boolean

        是否接收

      Returns void

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

loadMessageCount 的接口监听

Type declaration

    • (
          code: number,
          type: RCIMIWConversationType,
          targetId: string,
          channelId: string,
          count: number,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • type: RCIMIWConversationType

        会话类型

      • targetId: string

        会话 ID

      • channelId: string

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

      • count: number

        消息的数量

      Returns void

onTopConversationsLoaded?: (
    code: number,
    conversationTypes: RCIMIWConversationType[],
    channelId: string,
    conversations: RCIMIWConversation[],
) => void

Type declaration

    • (
          code: number,
          conversationTypes: RCIMIWConversationType[],
          channelId: string,
          conversations: RCIMIWConversation[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • conversationTypes: RCIMIWConversationType[]

        会话类型集合

      • channelId: string

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

      • conversations: RCIMIWConversation[]

        加载的会话集合

      Returns void

onGroupMessageToDesignatedUsersAttached?: (message: RCIMIWMessage) => void

sendGroupMessageToDesignatedUsers 的接口回调 消息存入数据库的回调

Type declaration

onGroupMessageToDesignatedUsersSent?: (
    code: number,
    message: RCIMIWMessage,
) => void

sendGroupMessageToDesignatedUsers 的接口回调 消息发送完成的回调

Type declaration

    • (code: number, message: RCIMIWMessage): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMessage

        发送的消息内容

      Returns void

onUltraGroupReadStatusSynced?: (
    code: number,
    targetId: string,
    channelId: string,
    timestamp: number,
) => void

syncUltraGroupReadStatus 的接口监听

Type declaration

    • (code: number, targetId: string, channelId: string, timestamp: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

        已读时间

      Returns void

onConversationsLoadedForAllChannel?: (
    code: number,
    type: RCIMIWConversationType,
    targetId: string,
    conversations: RCIMIWConversation[],
) => void

loadConversationsForAllChannel 的接口监听

Type declaration

onUltraGroupUnreadMentionedCountLoaded?: (
    code: number,
    targetId: string,
    count: number,
) => void

loadUltraGroupUnreadMentionedCount 的接口监听

Type declaration

    • (code: number, targetId: string, count: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • count: number

        未读数量

      Returns void

onUltraGroupUnreadCountLoaded?: (
    code: number,
    targetId: string,
    count: number,
) => void
onUltraGroupMessageModified?: (code: number, messageUId: string) => void

modifyUltraGroupMessage 的接口监听

Type declaration

    • (code: number, messageUId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messageUId: string

        消息的 messageUid

      Returns void

onUltraGroupMessageRecalled?: (
    code: number,
    message: RCIMIWMessage,
    deleteRemote: boolean,
) => void

recallUltraGroupMessage 的接口监听

Type declaration

    • (code: number, message: RCIMIWMessage, deleteRemote: boolean): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • message: RCIMIWMessage

        撤回的消息

      • deleteRemote: boolean

        调用接口时传入的是否删除远端消息

      Returns void

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

clearUltraGroupMessages 的接口监听

Type declaration

    • (
          code: number,
          targetId: string,
          channelId: string,
          timestamp: number,
          policy: RCIMIWMessageOperationPolicy,
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • timestamp: number

        时间戳

      • policy: RCIMIWMessageOperationPolicy

        清除策略

      Returns void

onUltraGroupMessagesClearedForAllChannel?: (
    code: number,
    targetId: string,
    timestamp: number,
) => void

clearUltraGroupMessagesForAllChannel 的接口监听

Type declaration

    • (code: number, targetId: string, timestamp: number): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • timestamp: number

        时间戳

      Returns void

onUltraGroupTypingStatusSent?: (
    code: number,
    targetId: string,
    channelId: string,
    typingStatus: TEXT,
) => void

sendUltraGroupTypingStatus 的接口监听

Type declaration

    • (code: number, targetId: string, channelId: string, typingStatus: TEXT): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • targetId: string

        会话 ID

      • channelId: string

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

      • typingStatus: TEXT

        输入状态枚举

      Returns void

onBatchRemoteUltraGroupMessagesLoaded?: (
    code: number,
    matchedMessages: RCIMIWMessage[],
    notMatchedMessages: RCIMIWMessage[],
) => void

loadBatchRemoteUltraGroupMessages 的接口监听

Type declaration

    • (
          code: number,
          matchedMessages: RCIMIWMessage[],
          notMatchedMessages: RCIMIWMessage[],
      ): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • matchedMessages: RCIMIWMessage[]

        从服务获取的消息列表

      • notMatchedMessages: RCIMIWMessage[]

        非法参数或者从服务没有拿到对应消息

      Returns void

onUltraGroupMessageExpansionUpdated?: (
    code: number,
    expansion: Map<string, string>,
    messageUId: string,
) => void

updateUltraGroupMessageExpansion 的接口监听

Type declaration

    • (code: number, expansion: Map<string, string>, messageUId: string): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • expansion: Map<string, string>

        更新的消息扩展信息键值对

      • messageUId: string

        消息的 messageUid

      Returns void

onUltraGroupMessageExpansionForKeysRemoved?: (
    code: number,
    messageUId: string,
    keys: string[],
) => void

removeUltraGroupMessageExpansionForKeys 的接口监听

Type declaration

    • (code: number, messageUId: string, keys: string[]): void
    • Parameters

      • code: number

        接口回调的状态码,0 代表成功,非 0 代表出现异常

      • messageUId: string

        消息的 messageUid

      • keys: string[]

        消息扩展信息中待删除的 key 的列表

      Returns void

MMNEPVFCICPMFPCPTTAAATR