nim.subscribe_event.NIMSubscribeEvent

Class: NIMSubscribeEvent

nim/subscribe_event.NIMSubscribeEvent

Hierarchy

• EventEmitter<NIMSubscribeEventEvents>

  ↳ NIMSubscribeEvent

Table of contents

Methods

• eventNames
• listeners
• listenerCount
• emit
• on
• addListener
• once
• removeListener
• off
• removeAllListeners
• initEventHandlers
• publish
• subscribe
• unSubscribe
• batchUnSubscribe
• querySubscribe

Properties

• subscribeEvent

Constructors

• constructor

Methods

eventNames

▸ eventNames(): keyof NIMSubscribeEventEvents[]

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

Returns

keyof NIMSubscribeEventEvents[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15

---

listeners

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

Return the listeners registered for a given event.

Type parameters

Name	Type
T	extends keyof NIMSubscribeEventEvents

Parameters

Name	Type
event	T

Returns

(...args: ArgumentMap<NIMSubscribeEventEvents>[Extract<T, keyof NIMSubscribeEventEvents>]) => 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	keyof NIMSubscribeEventEvents

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 keyof NIMSubscribeEventEvents

Parameters

Name	Type
event	T
...args	ArgumentMap<NIMSubscribeEventEvents>[Extract<T, keyof NIMSubscribeEventEvents>]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32

---

on

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

Add a listener for a given event.

Type parameters

Name	Type
T	extends keyof NIMSubscribeEventEvents

Parameters

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

Returns

NIMSubscribeEvent

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40

---

addListener

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

Type parameters

Name	Type
T	extends keyof NIMSubscribeEventEvents

Parameters

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

Returns

NIMSubscribeEvent

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45

---

once

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

Add a one-time listener for a given event.

Type parameters

Name	Type
T	extends keyof NIMSubscribeEventEvents

Parameters

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

Returns

NIMSubscribeEvent

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54

---

removeListener

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

Remove the listeners of a given event.

Type parameters

Name	Type
T	extends keyof NIMSubscribeEventEvents

Parameters

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

Returns

NIMSubscribeEvent

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63

---

off

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

Type parameters

Name	Type
T	extends keyof NIMSubscribeEventEvents

Parameters

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

Returns

NIMSubscribeEvent

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69

---

removeAllListeners

▸ removeAllListeners(event?): NIMSubscribeEvent

Remove all listeners, or those of the specified event.

Parameters

Name	Type
event?	keyof NIMSubscribeEventEvents

Returns

NIMSubscribeEvent

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79

---

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/nim/subscribe_event.ts:32

---

publish

▸ publish(data, cb, jsonExtension): Promise<null | [NIMResCode, number, EventData]>

发布事件

Note

200:成功
403:应用没开通事件服务
404:禁用了特定事件
414:参数错误
500:未知错误

Parameters

Name	Type	Description
data	EventData	-
cb	null | PublishEventCallback	发布事件回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [NIMResCode, number, EventData]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/subscribe_event.ts:50

---

subscribe

▸ subscribe(eventType, ttl, syncType, accids, cb, jsonExtension): Promise<null | [NIMResCode, number, string[]]>

订阅事件

Note

200:成功
414:参数错误
500:未知错误

Parameters

Name	Type	Description
eventType	NIMEventType	-
ttl	number	订阅有效期，单位：秒，范围：60s到30天
syncType	NIMEventSubscribeSyncEventType	-
accids	string[]	-
cb	null | SubscribeEventCallback	订阅事件回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [NIMResCode, number, string[]]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/subscribe_event.ts:80

---

unSubscribe

▸ unSubscribe(eventType, accids, cb, jsonExtension): Promise<null | [NIMResCode, number, string[]]>

按账号取消指定事件的订阅关系

Note

200:成功
414:参数错误
500:未知错误

Parameters

Name	Type	Description
eventType	NIMEventType	-
accids	string[]	-
cb	null | UnSubscribeEventCallback	取消订阅事件回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [NIMResCode, number, string[]]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/subscribe_event.ts:122

---

batchUnSubscribe

▸ batchUnSubscribe(eventType, cb, jsonExtension): Promise<null | [NIMResCode, number]>

取消指定事件的全部订阅关系

Note

200:成功
414:参数错误
500:未知错误

Parameters

Name	Type	Description
eventType	NIMEventType	-
cb	null | BatchUnSubscribeEventCallback	取消订阅事件回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [NIMResCode, number]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/subscribe_event.ts:159

---

querySubscribe

▸ querySubscribe(eventType, accids, cb, jsonExtension): Promise<[NIMResCode, number, EventSubscribeData[]]>

按账号查询指定事件订阅关系

Note

200:成功
414:参数错误
500:未知错误

Parameters

Name	Type	Description
eventType	NIMEventType	-
accids	string[]	-
cb	null | QuerySubscribeEventCallback	查询订阅关系回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<[NIMResCode, number, EventSubscribeData[]]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/subscribe_event.ts:191

Properties

subscribeEvent

• subscribeEvent: NIMSubscribeEventAPI

Defined in

ts/nim/subscribe_event.ts:25

Constructors

constructor

• new NIMSubscribeEvent()

Overrides

EventEmitter<NIMSubscribeEventEvents&gt;.constructor

Defined in

ts/nim/subscribe_event.ts:26