Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QChatInterface

Hierarchy

  • QChatInterface

Implemented by

Index

Properties

Methods

Properties

status

status: NIMEQChatInstanceStatus

实例状态

Methods

destroy

  • destroy(): Promise<void>

  • 销毁实例

    销毁当前 IM 实例，同时会退出登录状态，并断开 websocket 连接

    移除所有监听事件，销毁部分内部变量，并且此实例再也无法调用 login 恢复 IM 连接

    example
    await qchat.destroy()

    Returns Promise<void>

kickOtherClients

  • 踢出当前用户从其它端登录上来的连接

    example
    const result = await qchat.kickOtherClients({
      deviceIds: ['device-id-1', 'device-id-2']
    })
    console.log('kicked devices:', result.deviceIds)

    Parameters

    Returns Promise<KickOtherClientsResult>

login

  • login(): Promise<void>

  • 建立连接，并且登录

    example
    await qchat.login()

    Returns Promise<void>

logout

  • logout(): Promise<void>

  • 断开连接。

    退出登录状态，并断开 websocket 连接

    logout 完成后，实例不会被销毁，可再次 login 方法登录

    example
    await qchat.logout()

    Returns Promise<void>

setOptions

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

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

    example
    qchat.setOptions({
      token: 'new-token'
    })

    Parameters

    Returns void