Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConversationModule

Hierarchy

  • ConversationModule

Index

Properties

Constructors

Methods

Properties

Private _context

_context: default

Constructors

constructor

  • Parameters

    • apiContext: default
    • logger: ILogger

    Returns ConversationModule

Methods

getList

  • 获取会话列表

    Parameters

    • options: { count?: number; startTime?: number; order?: 0 | 1 }
      • Optional count?: number

        会话数量

      • Optional startTime?: number

        获取起始时间 默认值: 0 order 为 0 startTime 默认值为当前时间 order 为 1 startTime 默认值为所有会话中最早的消息时间

      • Optional order?: 0 | 1

        默认值: 0 0 获取 startTime 之前的 1 获取 startTime 之后的

    Returns Promise<IAReceivedConversation[]>

get

  • 获取指定会话实例，通过实例可实现向指定会话收发消息等功能

    description

    通过该方法获取的会话可能并不存在于当前的会话列表中，此处只作为功能性封装语法糖

    Parameters

    Returns Conversation

remove

  • Parameters

    Returns Promise<void>

getTotalUnreadCount

  • getTotalUnreadCount(includeMuted?: boolean, conversationTypes?: ConversationType[]): Promise<number>

  • 获取当前所有会话的消息未读数

    description
    1. 清除浏览器缓存会导致会话未读数不准确
    2. 会话消息未读数存储在 WebStorage 中, 若浏览器不支持或禁用 WebStorage，未读消息数将不会保存，浏览器页面刷新未读消息数将不会存在
    3. 其他端删除会话可能会导致会话未读数不准确

    Parameters

    • Optional includeMuted: boolean

      是否包含免打扰会话

    • Optional conversationTypes: ConversationType[]

      要获取未读数的会话类型，若为空，则默认获取单聊、群聊及系统消息未读数

    Returns Promise<number>

readAll

  • 清除全部会话未读数

    Returns Promise<ErrorCode>

merge

  • 合并会话

    Parameters

    Returns any[]