nim.plugin.NIMPlugin

Class: NIMPlugin

nim/plugin.NIMPlugin

Hierarchy

• EventEmitter<NIMPluginEvents>

  ↳ NIMPlugin

Table of contents

Methods

• eventNames
• listeners
• listenerCount
• emit
• on
• addListener
• once
• removeListener
• off
• removeAllListeners
• initEventHandlers
• chatRoomRequestEnterAsync
• qchatRequestLinkAddress

Properties

• plugin

Constructors

• constructor

Methods

eventNames

▸ eventNames(): never[]

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

Returns

never[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15

---

listeners

▸ listeners<T>(event): (...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void[]

Return the listeners registered for a given event.

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T

Returns

(...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void[]

Inherited from

EventEmitter.listeners

Defined in

node_modules/eventemitter3/index.d.ts:20

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type
event	never

Returns

number

Inherited from

EventEmitter.listenerCount

Defined in

node_modules/eventemitter3/index.d.ts:27

---

emit

▸ emit<T>(event, ...args): boolean

Calls each of the listeners registered for a given event.

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T
...args	ArgumentMap<NIMPluginEvents>[Extract<T, never>]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32

---

on

▸ on<T>(event, fn, context?): NIMPlugin

Add a listener for a given event.

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T
fn	(...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void
context?	any

Returns

NIMPlugin

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40

---

addListener

▸ addListener<T>(event, fn, context?): NIMPlugin

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T
fn	(...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void
context?	any

Returns

NIMPlugin

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45

---

once

▸ once<T>(event, fn, context?): NIMPlugin

Add a one-time listener for a given event.

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T
fn	(...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void
context?	any

Returns

NIMPlugin

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54

---

removeListener

▸ removeListener<T>(event, fn?, context?, once?): NIMPlugin

Remove the listeners of a given event.

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T
fn?	(...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void
context?	any
once?	boolean

Returns

NIMPlugin

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63

---

off

▸ off<T>(event, fn?, context?, once?): NIMPlugin

Type parameters

Name	Type
T	extends never

Parameters

Name	Type
event	T
fn?	(...args: ArgumentMap<NIMPluginEvents>[Extract<T, never>]) => void
context?	any
once?	boolean

Returns

NIMPlugin

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69

---

removeAllListeners

▸ removeAllListeners(event?): NIMPlugin

Remove all listeners, or those of the specified event.

Parameters

Name	Type
event?	undefined

Returns

NIMPlugin

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79

---

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/nim/plugin.ts:16

---

chatRoomRequestEnterAsync

▸ chatRoomRequestEnterAsync(roomId, cb, ext): Promise<[NIMResCode, string]>

异步获取聊天室登录信息

Note

200:成功
414:参数错误
404:聊天室不存在
403:不允许进入该聊天室
415:服务不可用，没有聊天室服务器可分配
13003:在黑名单中

Parameters

Name	Type	Description
roomId	number	聊天室ID
cb	null | ChatRoomRequestEnterCallback	回调函数
ext	string	json扩展参数（备用，目前不需要）

Returns

Promise<[NIMResCode, string]>

void 无返回值

Defined in

ts/nim/plugin.ts:35

---

qchatRequestLinkAddress

▸ qchatRequestLinkAddress(ip_version, cb, ext): Promise<[NIMResCode, string[]]>

异步获取圈组link地址 @param[in] ip_version ip协议, 0:ipv4, 1:ipv6, 2:all @param[in] callback 回调函数 @param[in] jsonExtension json扩展参数（备用，目前不需要）

Note

200:成功
414:参数错误

Parameters

Name	Type
ip_version	number
cb	null | QChatRequestLinkAddressCallback
ext	string

Returns

Promise<[NIMResCode, string[]]>

void 无返回值

Defined in

ts/nim/plugin.ts:61

Properties

plugin

• plugin: NIMPluginAPI

Defined in

ts/nim/plugin.ts:9

Constructors

constructor

• new NIMPlugin()

Overrides

EventEmitter<NIMPluginEvents&gt;.constructor

Defined in

ts/nim/plugin.ts:10