Class ChatRoom

constructor

• new ChatRoom(token?: string): ChatRoom

  实例化聊天室

  Parameters

  • token: string = ''

    认证 Token

  Returns ChatRoom

redpacket

discusse

• get discusse(): string

  当前聊天室话题，需要先调用 addListener 添加聊天室消息监听

  Returns string

• set discusse(val: string): void

  設置当前聊天室话题

  Parameters

  • val: string

    话题内容

  Returns void

onlines

• get onlines(): IOnlineInfo[]

  当前在线人数列表，需要先调用 addListener 添加聊天室消息监听

  Returns IOnlineInfo[]

barrage

• barrage(msg: string, color?: string): Promise<void>

  发送一条弹幕

  Parameters

  • msg: string

    消息内容，支持 Markdown

  • color: string = '#ffffff'

    弹幕颜色

  Returns Promise<void>

barragePay

• barragePay(): Promise<{ cost: number; unit: string }>

  获取弹幕发送价格

  Returns Promise<{ cost: number; unit: string }>

  返回价格cost与单位unit

connect

• connect(reload?: boolean): Promise<ReconnectingWebSocket>

  连接聊天室

  Parameters

  • Optionalreload: boolean

  Returns Promise<ReconnectingWebSocket>

  返回 Open Event

• connect(url?: string, timeout?: number): Promise<ReconnectingWebSocket>

  连接聊天室

  Parameters

  • Optionalurl: string

    聊天室节点地址

  • Optionaltimeout: number

    超时时间，单位为秒，默认为 10

  Returns Promise<ReconnectingWebSocket>

  返回 Open Event

get

• get(
      params: {
          mode?: ChatMessageType;
          oId: string;
          size?: number;
          type?: ChatContentType;
      },
  ): Promise<IChatRoomMessage[]>

  获取指定消息附近的聊天室消息

  Parameters

  • params: { mode?: ChatMessageType; oId: string; size?: number; type?: ChatContentType }

    获取参数

    • Optionalmode?: ChatMessageType

      获取模式，context 上下文模式，after 之后模式

    • oId: string

      消息 Id

    • Optionalsize?: number

      获取消息数量，默认 25，最大 100

    • Optionaltype?: ChatContentType

      获取消息类型，默认 HTML

  Returns Promise<IChatRoomMessage[]>

  聊天室消息列表

getNode

• getNode(): Promise<IChatRoomNodeInfo>

  获取聊天室节点

  Returns Promise<IChatRoomNodeInfo>

  返回节点地址

history

• history(page?: number, type?: ChatContentType): Promise<IChatRoomMessage[]>

  查询聊天室历史消息

  Parameters

  • page: number = 1

    消息页码

  • type: ChatContentType = ChatContentType.HTML

    消息内容类型，HTML 或 Raw，默认 HTML

  Returns Promise<IChatRoomMessage[]>

mutes

• mutes(): Promise<IMuteItem[]>

  获取禁言中成员列表（思过崖）

  Returns Promise<IMuteItem[]>

raw

• raw(oId: string): Promise<string>

  获取消息原文（比如 Markdown）

  Parameters

  • oId: string

    消息 Id

  Returns Promise<string>

revoke

• revoke(oId: string): Promise<void>

  撤回消息，普通成员 24 小时内可撤回一条自己的消息，纪律委员/OP/管理员角色可以撤回任意人消息

  Parameters

  • oId: string

    消息 Id

  Returns Promise<void>

send

• send(msg: string, clientType?: string, version?: string): Promise<void>

  发送一条消息

  Parameters

  • msg: string

    消息内容，支持 Markdown

  • OptionalclientType: string
  • Optionalversion: string

  Returns Promise<void>

setToken

• setToken(apiKey: string): void

  重新设置请求 Token

  Parameters

  • apiKey: string

    接口 API Key

  Returns void

setVia

• setVia(client: string, version: string): void

  设置当前来源类型

  Parameters

  • client: string

    来源类型

  • version: string

    版本号

  Returns void