Interface V2TIMConversationListener

（六）会话事件的监听类

Optional onSyncServerStart

onSyncServerStart?: (() => void)

Type declaration

    • (): void

    • 同步服务器会话开始，SDK 会在登录成功或者断网重连后自动同步服务器会话，您可以监听这个事件做一些 UI 进度展示操作。

      Returns void

Optional onSyncServerFinish

onSyncServerFinish?: (() => void)

Type declaration

    • (): void

    • 同步服务器会话完成，如果会话有变更，会通过 OnNewConversation | OnConversationChanged 回调告知客户

      Returns void

Optional onSyncServerFailed

onSyncServerFailed?: (() => void)

Type declaration

    • (): void

    • 同步服务器会话失败

      Returns void

Optional onNewConversation

onNewConversation?: ((conversationList) => void)

Type declaration

    • (conversationList): void

    • 有新的会话（比如收到一个新同事发来的单聊消息、或者被拉入了一个新的群组中），可以根据会话的 orderKey 重新对会话列表做排序

      Parameters

      Returns void

Optional onConversationChanged

onConversationChanged?: ((conversationList) => void)

Type declaration

    • (conversationList): void

    • 某些会话的关键信息发生变化（未读计数发生变化、最后一条消息被更新等等），可以根据会话的 orderKey 重新对会话列表做排序

      Parameters

      Returns void

Optional onConversationDeleted

onConversationDeleted?: ((conversationIDList) => void)

Type declaration

    • (conversationIDList): void

    • 会话被删除的通知（7.2 及以上版本支持）

      Parameters

      • conversationIDList: string[]

      Returns void

      Note

      conversationIDList 表示被删除的会话唯一 ID 列表。C2C 单聊组成方式为: "c2c_userID"：群聊组成方式为: "group_groupID"

Optional onTotalUnreadMessageCountChanged

onTotalUnreadMessageCountChanged?: ((totalUnreadCount) => void)

Type declaration

    • (totalUnreadCount): void

    • 全部会话未读总数变更的通知（5.3.425 及以上版本支持）

      Parameters

      • totalUnreadCount: number

      Returns void

      Note

      • 当您调用 GetTotalUnreadMessageCount 获取全部会话未读总数以后，任意会话的未读数发生变化时，SDK 都会通过该回调把最新的未读总数通知给您。
      • 未读总数会减去设置为免打扰的会话的未读数，即消息接收选项设置为 V2TIM_NOT_RECEIVE_MESSAGE or V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE or V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT 的会话。

Optional onUnreadMessageCountChangedByFilter

onUnreadMessageCountChangedByFilter?: ((filter, totalUnreadCount) => void)

Type declaration

    • (filter, totalUnreadCount): void

    • 根据 filter 过滤的未读消息总数变更通知（7.0 及以上版本支持）

      Parameters

      Returns void

      Note

      • 您可以调用 SubscribeUnreadMessageCountByFilter 注册监听指定 filter 下的未读总数变化，SDK 通过这个回调把最新的未读总数通知给您。
      • 您可以注册监听多个不同 filter 下的未读总数变化，这个回调的 filter 参数就是注册监听时指定的 filter，该 filter 携带了 conversationType、conversationGroup 和 markType 三个字段，通过判断这三字段是不是都相同，来区分出不同的 filter。
      • 未读总数会减去设置为免打扰的会话的未读数，即消息接收选项设置为 V2TIM_NOT_RECEIVE_MESSAGE or V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE or V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT 的会话。

Optional onConversationGroupCreated

onConversationGroupCreated?: ((groupName, conversationList) => void)

Type declaration

    • (groupName, conversationList): void

    • 会话分组被创建

      Parameters

      Returns void

Optional onConversationGroupDeleted

onConversationGroupDeleted?: ((groupName) => void)

Type declaration

    • (groupName): void

    • 会话分组被删除

      Parameters

      • groupName: string

      Returns void

Optional onConversationGroupNameChanged

onConversationGroupNameChanged?: ((oldName, newName) => void)

Type declaration

    • (oldName, newName): void

    • 会话分组名变更

      Parameters

      • oldName: string
      • newName: string

      Returns void

Optional onConversationsAddedToGroup

onConversationsAddedToGroup?: ((groupName, conversationList) => void)

Type declaration

    • (groupName, conversationList): void

    • 会话分组新增会话

      Parameters

      Returns void

Optional onConversationsDeletedFromGroup

onConversationsDeletedFromGroup?: ((groupName, conversationList, reason) => void)

Type declaration

    • (groupName, conversationList, reason): void

    • 会话分组删除会话

      Parameters

      Returns void

      Note

      • reason 表示会话从所在分组删除的原因，其取值有：
      • 当 reason 为 0 时，表示由用户主动调用 deleteConversationsFromGroup 触发
      • 当 reason 为 1 时，表示添加到分组的会话数量超过 1000，最早添加进分组的会话被淘汰

Settings

Theme

On This Page

Generated using TypeDoc