Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Conversation

Hierarchy

  • Conversation

Index

Properties

Constructors

Methods

Properties

Readonly targetId

targetId: string

会话 id

Readonly type

type: ConversationType

会话类型

Constructors

constructor

Methods

destory

  • destory(): Promise<void>

  • 删除指定会话

    Returns Promise<void>

read

  • read(): Promise<void>

  • 清除会话未读数

    Returns Promise<void>

getUnreadCount

  • getUnreadCount(): Promise<number>

  • 获取指定会话未读数

    Returns Promise<number>

send

  • 发送消息

    deprecated

    options.isPersited

    deprecated

    options.isCounted

    deprecated

    options.isStatusMessage

    Parameters

    Returns Promise<IAReceivedMessage>

setStatus

  • setStatus(status: { notificationStatus?: NotificationStatus; isTop?: boolean }): Promise<void>

  • 设置会话状态

    Parameters

    • status: { notificationStatus?: NotificationStatus; isTop?: boolean }
      • Optional notificationStatus?: NotificationStatus

        是否免打扰

        • 1: 开启免打扰
        • 2: 关闭免打扰
      • Optional isTop?: boolean

        是否置顶

    Returns Promise<void>

getMessages

recall

  • 撤回消息

    Parameters

    • options: { messageUId: string; sentTime: number; user?: IUserProfile; disableNotification?: boolean; pushConfig?: IPushConfig; extra?: string }
      • messageUId: string

        消息的唯一id，客户端依赖此属性查找要撤回的消息

      • sentTime: number

        消息发送时间，服务端依赖此属性查找要撤回的消息

      • Optional user?: IUserProfile

        撤回消息携带用户信息

      • Optional disableNotification?: boolean

        是否发送静默消息

        description

        当值为 true 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒

      • Optional pushConfig?: IPushConfig

        移动端推送配置

      • Optional extra?: string

        撤回消息携带扩展字段

    Returns Promise<IAReceivedMessage>

deleteMessages

  • deleteMessages(messages: { messageUId: string; sentTime: number; messageDirection: MessageDirection }[]): Promise<void>

  • 按消息 id 删除消息

    Parameters

    • messages: { messageUId: string; sentTime: number; messageDirection: MessageDirection }[]

    Returns Promise<void>

clearMessages

  • clearMessages(options: { timestamp: number }): Promise<void>

  • 按时间戳删除消息

    Parameters

    • options: { timestamp: number }
      • timestamp: number

        清除时间点, 该时间之前的消息将被清除

    Returns Promise<void>

updateMessageExpansion

  • 更新（添加、替换）消息扩展属性

    Parameters

    • expansion: {}

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

      • [key: string]: any
    • message: IAReceivedMessage

      要更新的原始消息体

    Returns Promise<void>

removeMessageExpansion

  • 删除扩展存储

    params

    keys 需删除消息扩展的 keys

    params

    message 原始消息体

    Parameters

    Returns Promise<void>

setDraft

  • setDraft(draft: string): Promise<void>

  • 设置会话文本草稿

    params

    conversationType 会话类型

    params

    targetId 目标 ID

    params

    draft 草稿内容

    Parameters

    • draft: string

    Returns Promise<void>

getDraft

  • getDraft(): Promise<string>

  • 获取会话文本草稿

    params

    conversationType 会话类型

    params

    targetId 目标 ID

    Returns Promise<string>

deleteDraft

  • deleteDraft(): Promise<void>

  • 删除会话文本草稿

    params

    conversationType 会话类型

    params

    targetId 目标 ID

    Returns Promise<void>

sendReadReceiptMessage

  • sendReadReceiptMessage(messageUIds: string[]): Promise<void>

  • 发送群已读回执（需要导航‘grpRRVer’为1）

    Parameters

    • messageUIds: string[]

      消息UID列表

    Returns Promise<void>

sendTypingStatusMessage

  • 发送typing消息

    Parameters

    • typingContentType: string

      输入状态消息类型

    Returns Promise<IAReceivedMessage>

getMessageReader

  • 获取群已读列表

    Parameters

    • messageUId: string

      消息UID

    Returns Promise<IMessageReaderResponse>

getInfo

  • 获取会话信息

    Returns Promise<IAReceivedConversation>

removeTags

  • removeTags(tagIds: string[]): Promise<number>

  • Parameters

    • tagIds: string[]

    Returns Promise<number>

getTags

  • 获取会话的标签

    Returns Promise<IConversationTag[]>