Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ChatroomInterface

Index

Properties

实例状态

  • unconnected: 尚未建立连接(初始化、主动登出、达到最大重连次数)
  • connecting: 正在建立连接中
  • connected: 已连接,尚未完成鉴权认证
  • logined: 已连接, 并且完成了鉴权认证,可以正常开始发送协议
  • waitReconnect: 等待重连中
  • destroyed: 实例已经销毁

Methods

  • connect(): Promise<void>
  • 建立连接,并且登录

    Returns Promise<void>

  • destroy(): Promise<void>
  • 销毁实例

    • 销毁当前 Chatroom 实例,同时会退出登录状态,并断开websocket连接
    • 移除所有监听事件,销毁部分内部变量,并且此实例再也无法调用 connect 恢复 Chatroom 连接

    Returns Promise<void>

  • disconnect(): Promise<void>
  • 断开连接。

    • 退出登录状态,并断开 websocket 连接
    • disconnect完成后,实例不会被销毁,可再次 connect 方法登录 Chatroom

    Returns Promise<void>

  • 更新初始化传入的参数,在初始化完成后使用

    请注意!传入的参数会在下一次调用connect或重连生效

    Parameters

    Returns void