nim.user.NIMUser

Class: NIMUser

Hierarchy

EventEmitter

↳ NIMUser

Methods

once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters

Name	Type
`emitter`	`NodeEventTarget`
`eventName`	`string` \| `symbol`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters

Name	Type
`emitter`	`DOMEventTarget`
`eventName`	`string`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

on

▸ Static on(emitter, eventName, options?): AsyncIterableIterator<any>

const { on, EventEmitter } = require('events');

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

const { on, EventEmitter } = require('events');
const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Since

v13.6.0, v12.16.0

Parameters

Name	Type	Description
`emitter`	`EventEmitter`	-
`eventName`	`string`	The name of the event being listened for
`options?`	`StaticEventEmitterOptions`	-

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

listenerCount

▸ Static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Parameters

Name	Type	Description
`emitter`	`EventEmitter`	The emitter to query
`eventName`	`string` \| `symbol`	The event name

Returns

number

getEventListeners

▸ Static getEventListeners(emitter, name): Function[]

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

const { getEventListeners, EventEmitter } = require('events');

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  getEventListeners(ee, 'foo'); // [listener]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  getEventListeners(et, 'foo'); // [listener]
}

Since

v15.2.0

Parameters

Name	Type
`emitter`	`EventEmitter` \| `DOMEventTarget`
`name`	`string` \| `symbol`

Returns

Function[]

addListener

▸ addListener(eventName, listener): NIMUser

Alias for emitter.on(eventName, listener).

Since

v0.1.26

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

NIMUser

removeListener

▸ removeListener(eventName, listener): NIMUser

Removes the specified listener from the listener array for the event namedeventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.1.26

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

NIMUser

off

▸ off(eventName, listener): NIMUser

Alias for emitter.removeListener().

Since

v10.0.0

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

NIMUser

removeAllListeners

▸ removeAllListeners(event?): NIMUser

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.1.26

Parameters

Name	Type
`event?`	`string` \| `symbol`

Returns

NIMUser

setMaxListeners

▸ setMaxListeners(n): NIMUser

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v0.3.5

Parameters

Name	Type
`n`	`number`

Returns

NIMUser

getMaxListeners

▸ getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Since

v1.0.0

Returns

number

listeners

▸ listeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Since

v0.1.26

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

rawListeners

▸ rawListeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Since

v9.4.0

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

emit

▸ emit(eventName, ...args): boolean

Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

const EventEmitter = require('events');
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Since

v0.1.26

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`...args`	`any`[]

Returns

boolean

listenerCount

▸ listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Since

v3.2.0

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event being listened for

Returns

number

prependListener

▸ prependListener(eventName, listener): NIMUser

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v6.0.0

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

NIMUser

prependOnceListener

▸ prependOnceListener(eventName, listener): NIMUser

Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Since

v6.0.0

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

NIMUser

eventNames

▸ eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Since

v6.0.0

Returns

(string | symbol)[]

on

▸ on(event, listener): NIMUser

Parameters

Name	Type
`event`	`"specialRelationChange"`
`listener`	(`result`: `SpecialRelationshipChangeEvent`) => `void`

Returns

NIMUser

▸ on(event, listener): NIMUser

Parameters

Name	Type
`event`	`"userNameCardChange"`
`listener`	(`result`: `UserNameCard`[]) => `void`

Returns

NIMUser

once

▸ once(event, listener): NIMUser

Parameters

Name	Type
`event`	`"specialRelationChange"`
`listener`	(`result`: `SpecialRelationshipChangeEvent`) => `void`

Returns

NIMUser

▸ once(event, listener): NIMUser

Parameters

Name	Type
`event`	`"userNameCardChange"`
`listener`	(`result`: `UserNameCard`[]) => `void`

Returns

NIMUser

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

setBlack

▸ setBlack(accid, setBlack, cb, jsonExtension): boolean

设置、取消设置黑名单

Note

200:成功
419:黑名单数量超过上限

Parameters

Name	Type	Description
`accid`	`string`	好友id
`setBlack`	`boolean`	-
`cb`	`SetRelationCallback`
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

boolean

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

setMute

▸ setMute(accid, set_mute, cb, jsonExtension): boolean

设置、取消设置静音名单

Note

200:成功
419:静音列表数量超过上限

Parameters

Name	Type	Description
`accid`	`string`	好友id
`set_mute`	`boolean`	取消或设置
`cb`	`SetRelationCallback`
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

boolean

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

getMutelist

▸ getMutelist(cb, jsonExtension): void

获得静音名单列表

Note

200:成功

Parameters

Name	Type	Description
`cb`	`GetSpecialListCallback`
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

void

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

getBlacklist

▸ getBlacklist(cb, jsonExtension): void

获得黑名单名单

Parameters

Name	Type	Description
`cb`	`GetSpecialListCallback`
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

void

void 无返回值

getUserNameCard

▸ getUserNameCard(accids, cb, jsonExtension): boolean

获取本地的指定帐号的用户名片

Note

200:成功
414:参数错误
20000:还未初始化或初始化未正常完成
20001:还未登陆或登录未完成

Parameters

Name	Type	Description
`accids`	`string`[]
`cb`	`GetUserNameCardCallback`	操作结果回调
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

boolean

void 无返回值

getUserNameCardOnline

▸ getUserNameCardOnline(accids, cb, jsonExtension): boolean

在线查询指定帐号的用户名片

Note

200:成功
414:参数错误
20000:还未初始化或初始化未正常完成
20001:还未登陆或登录未完成

Parameters

Name	Type	Description
`accids`	`string`[]
`cb`	`GetUserNameCardCallback`	操作结果回调
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

boolean

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

updateMyUserNameCard

▸ updateMyUserNameCard(nameCard, cb, jsonExtension): boolean

更新自己的用户名片

Note

200:成功
400:非法参数

Parameters

Name	Type	Description
`nameCard`	`UserNameCard`	-
`cb`	`UpdateMyUserNameCardCallback`	操作结果回调
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

boolean

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

queryUserListByKeyword

▸ queryUserListByKeyword(keyword, cb, jsonExtension): boolean

获取本地的指定帐号的用户名片

Parameters

Name	Type	Description
`keyword`	`string`	要查询的关键字
`cb`	`GetUserNameCardCallback`	操作结果回调
`jsonExtension`	`string`	json扩展参数（备用，目前不需要）

Returns

boolean

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

updatePushToken

▸ updatePushToken(cerName, token, type): void

更新推送证书

Parameters

Name	Type	Description
`cerName`	`string`	-
`token`	`string`	设备token
`type`	`NINPushType`	1： pushkit (仅iOS) 其他 apns 默认填0

Returns

void

void 无返回值

Properties

errorMonitor

▪ Static Readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Defined in

node_modules/@types/node/events.d.ts:272

captureRejectionSymbol

▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Defined in

node_modules/@types/node/events.d.ts:273

captureRejections

▪ Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Defined in

node_modules/@types/node/events.d.ts:278

defaultMaxListeners

▪ Static defaultMaxListeners: number

Defined in

node_modules/@types/node/events.d.ts:279

user

• user: NIMUserAPI

Defined in

ts/nim/user.ts:24

Constructors

constructor

• new NIMUser()

nim.user.NIMUser

Class: NIMUser

Hierarchy

Table of contents

Methods

Properties

Constructors

Methods

once

Parameters

Returns

Parameters

Returns

on

Parameters

Returns

listenerCount

Parameters

Returns

getEventListeners

Parameters

Returns

addListener

Parameters

Returns

removeListener

Parameters

Returns

off

Parameters

Returns

removeAllListeners

Parameters

Returns

setMaxListeners

Parameters

Returns

getMaxListeners

Returns

listeners

Parameters

Returns

rawListeners

Parameters

Returns

emit

Parameters

Returns

listenerCount

Parameters

Returns

prependListener

Parameters

Returns

prependOnceListener

Parameters

Returns

eventNames

Returns

on

Parameters

Returns

Parameters

Returns

once

Parameters

Returns

Parameters

Returns

initEventHandlers

Returns

setBlack

Parameters

Returns

setMute

Parameters

Returns

getMutelist

Parameters

Returns