Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Chatroom

Index

Properties

_context: default
_id: string

Constructors

  • new Chatroom(context: default, id: string, logger: ILogger): Chatroom
  • Parameters

    • context: default
    • id: string
    • logger: ILogger

    Returns Chatroom

Methods

  • join(options: { count: number }): Promise<void>
  • 加入聊天室

    Parameters

    • options: { count: number }
      • count: number

        拉取消息数

    Returns Promise<void>

  • joinExist(options: { count: number }): Promise<void>
  • 加入已存在的聊天室

    Parameters

    • options: { count: number }
      • count: number

        拉取消息数

    Returns Promise<void>

  • quit(): Promise<void>
  • 退出聊天室

    Returns Promise<void>

  • getInfo(options?: { count?: number; order?: 0 | 1 | 2 }): Promise<IChatroomInfo>
  • 获取聊天室房间数据

    description

    count 或 order 有一个为 0 时,只返回成员总数,不返回成员列表信息

    Parameters

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

        获取聊天室的人数,传值范围:0-20,默认为 0

      • Optional order?: 0 | 1 | 2

        聊天室的人员排序,默认为 0

        • 1: 升序
        • 2: 降序

    Returns Promise<IChatroomInfo>

  • 设置聊天室自定义属性

    description

    仅聊天室中不存在此属性或属性设置者为己方时可设置成功

    Parameters

    Returns Promise<void>

  • 批量设置聊天室自定义属性

    Parameters

    Returns Promise<void>

  • 强制 增加/修改 任意聊天室属性

    description

    仅聊天室中不存在此属性或属性设置者为己方时可设置成功

    Parameters

    Returns Promise<void>

  • 删除聊天室属性

    description

    仅限于删除自己设置的聊天室属性

    Parameters

    Returns Promise<void>

  • removeEntries(options: { entries: string[] }): Promise<void>
  • 批量删除聊天室属性

    description

    仅限于删除自己设置的聊天室属性

    Parameters

    • options: { entries: string[] }

      entries属性集合, 支持英文字母、数字、+、=、-、_ 的组合方式, 最大长度 128 字符

      • entries: string[]

    Returns Promise<void>

  • 强制删除聊天室内的任意属性

    description

    Parameters

    Returns Promise<void>

  • getEntry(key: string): Promise<string | number | boolean>
  • 获取聊天室的指定属性

    Parameters

    • key: string

    Returns Promise<string | number | boolean>

  • getAllEntries(): Promise<{}>
  • 获取聊天室的所有属性

    Returns Promise<{}>

  • recall(options: { messageUId: string; sentTime: number; user?: {} }): Promise<IAReceivedMessage>
  • 撤回聊天室消息

    Parameters

    • options: { messageUId: string; sentTime: number; user?: {} }
      • messageUId: string

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

      • sentTime: number

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

      • Optional user?: {}

        撤回消息携带用户信息

        • [key: string]: string

    Returns Promise<IAReceivedMessage>