Options
All
  • Public
  • Public/Protected
  • All
Menu

Class V2TIMConversationManager

Hierarchy

  • V2TIMConversationManager

Index

Methods 事件监听

Methods 会话置顶

Methods 会话草稿

Methods 删除会话

Methods 获取会话信息

Methods 获取会话未读总数

事件监听 Methods

addConversationListener

removeConversationListener

会话置顶 Methods

pinConversation

  • pinConversation(conversationID: string, isPinned: boolean): Promise<V2TimCallback>

会话草稿 Methods

setConversationDraft

  • setConversationDraft(conversationID: string, draftText?: string): Promise<V2TimCallback>

  • 设置会话草稿

    只在本地保存，不会存储 Server，不能多端同步，程序卸载重装会失效。

    Parameters

    • conversationID: string

      会话唯一 ID，C2C 单聊组成方式为: string.format("c2c_%s", "userID")；群聊组成方式为: string.format("group_%s", "groupID")

    • Optional draftText: string

      草稿内容, 为 null 则表示取消草稿

    Returns Promise<V2TimCallback>

删除会话 Methods

deleteConversation

  • deleteConversation(conversationID: string): Promise<V2TimCallback>

  • 删除会话
    note

    请注意:

    • 删除会话会在本地删除的同时，在服务器也会同步删除。
    • 会话内的消息在本地删除的同时，在服务器也会同步删除。

    Parameters

    • conversationID: string

      会话唯一 ID，C2C 单聊组成方式为: string.format("c2c_%s", "userID")；群聊组成方式为: string.format("group_%s", "groupID")

    Returns Promise<V2TimCallback>

获取会话信息 Methods

getConversation

getConversationList

  • 获取会话列表
    • 一个会话对应一个聊天窗口，比如跟一个好友的 1v1 聊天，或者一个聊天群，都是一个会话。
    • 由于历史的会话数量可能很多，所以该接口希望您采用分页查询的方式进行调用，每次分页拉取的个数建议为 100 个。
    • 该接口拉取的是本地缓存的会话，如果服务器会话有更新，SDK 内部会自动同步，然后在 V2TIMConversationListener 回调告知客户。
    • 如果会话全部拉取完毕，成功回调里面 V2TIMConversationResult 中的 isFinished 获取字段值为 true。

    Parameters

    • count: number

      分页拉取的个数，一次分页拉取不宜太多，会影响拉取的速度，建议每次拉取 100 个会话

    • nextSeq: string

      分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextSeq

    Returns Promise<V2TimValueCallback<{ conversationList?: V2TimConversation[]; isFinished?: boolean; nextSeq?: string }>>

getConversationListByConversaionIds

获取会话未读总数 Methods

getTotalUnreadMessageCount