default | qchat

Hierarchy

EventEmitter<QChatEventInterface>
- default

Implements

QChatInterface

Index

Constructors

constructor

new default(options: QChatInitializeOptions, otherOptions?: QChatOtherOptions): default

Overrides EventEmitter<QChatEventInterface>.constructor
Parameters
- options: QChatInitializeOptions
- Optional otherOptions: QChatOtherOptions
Returns default

Properties

account

account: string

账号

cloudStorage

cloudStorage: CloudStorageServiceInterface

options

options: QChatInitializeOptions

连接参数

status

status: NIMEQChatInstanceStatus = 'unconnected'

实例的状态

Static instance

instance: null | default

Methods

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void), context?: any): default

Inherited from EventEmitter.addListener
Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
- fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)
  - - (...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]): void
    - Parameters
      - Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]
      Returns void
- Optional context: any
Returns default

destroy

destroy(): Promise<void>

Implementation of QChatInterface.destroy

销毁实例

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

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

Returns Promise<void>

emit

emit<T>(event: T, ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]): boolean

Inherited from EventEmitter.emit

Calls each of the listeners registered for a given event.

Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
- Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]
Returns boolean

eventNames

eventNames(): (keyof QChatEventInterface)[]

Inherited from EventEmitter.eventNames

Return an array listing the events for which the emitter has registered listeners.

Returns (keyof QChatEventInterface)[]

kickOtherClients

kickOtherClients(options: KickOtherClientsOptions): Promise<KickOtherClientsResult>

Implementation of QChatInterface.kickOtherClients

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

Parameters
- options: KickOtherClientsOptions
Returns Promise<KickOtherClientsResult>

listenerCount

listenerCount(event: keyof QChatEventInterface): number

Inherited from EventEmitter.listenerCount

Return the number of listeners listening to a given event.

Parameters
- event: keyof QChatEventInterface
Returns number

listeners

listeners<T>(event: T): ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)[]

Inherited from EventEmitter.listeners

Return the listeners registered for a given event.

Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
Returns ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)[]

login

Implementation of QChatInterface.login

建立连接，并且登录

Returns Promise<void>

logout

logout(): Promise<void>

Implementation of QChatInterface.logout

断开连接。

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

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

Returns Promise<void>

off

off<T>(event: T, fn?: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void), context?: any, once?: boolean): default

Inherited from EventEmitter.off
Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)
  - - (...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]): void
    - Parameters
      - Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns default

on

on<T>(event: T, fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void), context?: any): default

Inherited from EventEmitter.on

Add a listener for a given event.

Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
- fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)
  - - (...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]): void
    - Parameters
      - Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]
      Returns void
- Optional context: any
Returns default

once

once<T>(event: T, fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void), context?: any): default

Inherited from EventEmitter.once

Add a one-time listener for a given event.

Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
- fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)
  - - (...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]): void
    - Parameters
      - Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]
      Returns void
- Optional context: any
Returns default

removeAllListeners

removeAllListeners(event?: keyof QChatEventInterface): default

Inherited from EventEmitter.removeAllListeners

Remove all listeners, or those of the specified event.

Parameters
- Optional event: keyof QChatEventInterface
Returns default

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void), context?: any, once?: boolean): default

Inherited from EventEmitter.removeListener

Remove the listeners of a given event.

Type Parameters
- T extends keyof QChatEventInterface
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)
  - - (...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]): void
    - Parameters
      - Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns default

setOptions

setOptions(): Promise<void>

Implementation of QChatInterface.setOptions

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

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

Returns Promise<void>

Static getInstance

getInstance(_options?: QChatInitializeOptions, _otherOptions?: QChatOtherOptions): default

单例模式获取实例

Parameters
- Optional _options: QChatInitializeOptions
- Optional _otherOptions: QChatOtherOptions
Returns default

Static setAdapters

setAdapters(_newAdapters: any): void

设置适配器

Parameters
- _newAdapters: any
  
  适配器
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: QChatInitializeOptions

Optional otherOptions: QChatOtherOptions

Returns default

Properties

account

cloudStorage

options

qchatChannel

qchatMedia

qchatMsg

qchatRole

qchatServer

status

Static instance

Methods

addListener

Type Parameters

T extends keyof QChatEventInterface

Parameters

event: T

fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)

Parameters

Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]

Returns void

Optional context: any

Returns default

destroy

Returns Promise<void>

emit

Type Parameters

T extends keyof QChatEventInterface

Parameters

event: T

Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]

Returns boolean

eventNames

Returns (keyof QChatEventInterface)[]

kickOtherClients

Parameters

options: KickOtherClientsOptions

Returns Promise<KickOtherClientsResult>

listenerCount

Parameters

event: keyof QChatEventInterface

Returns number

listeners

Type Parameters

T extends keyof QChatEventInterface

Parameters

event: T

Returns ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)[]

login

Returns Promise<void>

logout

Returns Promise<void>

off

Type Parameters

T extends keyof QChatEventInterface

Parameters

event: T

Optional fn: ((...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]) => void)

Parameters

Rest ...args: ArgumentMap<QChatEventInterface>[Extract<T, keyof QChatEventInterface>]

Returns void

Optional context: any

Optional once: boolean

Returns default

on

Type Parameters

T extends keyof QChatEventInterface

Parameters