Class NIMClient

Hierarchy

EventEmitter<NIMClientEvents>
- NIMClient

Constructors

constructor

new NIMClient(): NIMClient
Returns NIMClient
Overrides EventEmitter<NIMClientEvents>.constructor
- Defined in ts/nim/client.ts:38

Properties

client

client: NIMClientAPI

Methods

eventNames

eventNames(): (keyof NIMClientEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof NIMClientEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listeners

listeners<T>(event): ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof NIMClientEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => 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
- event: keyof NIMClientEvents
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
- T extends keyof NIMClientEvents
Parameters
- event: T
- Rest...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends keyof NIMClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends keyof NIMClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof NIMClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof NIMClientEvents
Parameters
- event: T
- Optionalfn: ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof NIMClientEvents
Parameters
- event: T
- Optionalfn: ((...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<NIMClientEvents>[Extract<T, keyof NIMClientEvents>]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof NIMClientEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

initEventHandlers

initEventHandlers(): void
注册全局回调

Returns void
- Defined in ts/nim/client.ts:44

init

init(appKey, appDataDir, appInstallDir, config): boolean
NIM SDK初始化
Parameters
- appKey: string
  应用注册的APP KEY
- appDataDir: string
  推荐用户目录放置在系统目录AppData\Local，默认只需要传入目录名，SDK会默认在系统目录下创建该级用户目录。如果要使用其他自定义路径，需传入绝对路径路径，并确保该目录有正确的读写权限。
- appInstallDir: string
  Deprecated
- config: SDKConfig
  初始化参数
Returns boolean
bool 返回值true: 成功， false: 失败
- Defined in ts/nim/client.ts:55

login

login(appKey, account, password, cb, jsonExtension): Promise<[LoginRes]>
NIM客户端登录
Parameters
- appKey: string
- account: string
  帐号
- password: string
  密码
- cb: null | LoginCallback
  登录流程的回调函数
- jsonExtension: string
  json扩展参数（v5.7.0 项目增加自定义参数字段）
Returns Promise<[LoginRes]>
bool 检查参数如果不符合要求则返回失败
Note
```
200:成功
302:账号或密码错误
403:禁止操作
408:请求超时
414:参数错误
415:网络连接出现错误
416:频率超限
422:账号被禁用
```
- Defined in ts/nim/client.ts:78

logout

logout(logoutType, cb, jsonExtension): Promise<[NIMResCode]>
NIM客户端注销/退出
Parameters
- logoutType: NIMLogoutType
  Logout操作类型，其定义见nim_client_def.h
- cb: null | LogoutCallback
  注销/退出的回调函数
- jsonExtension: string
  json扩展参数（备用，目前不需要）
Returns Promise<[NIMResCode]>
void 无返回值
Note
```
200:成功
500:未知错误
```
- Defined in ts/nim/client.ts:108

cleanup

cleanup(jsonExtension): void
NIM SDK清理
Parameters
- jsonExtension: string
  json扩展参数（备用，目前不需要）
Returns void
void 无返回值
- Defined in ts/nim/client.ts:127

getSDKConfig

getSDKConfig(): SDKConfig
获取SDK配置

Returns SDKConfig
SDKConfig 返回值SDKConfig的引用 const类型，不可试图修改
- Defined in ts/nim/client.ts:134

getLoginState

getLoginState(jsonExtension): NIMLoginState
获取客户端登录状态
Parameters
- jsonExtension: string
  json扩展参数（备用，目前不需要）
Returns NIMLoginState
NIMLoginState 登录状态
- Defined in ts/nim/client.ts:142

relogin

relogin(jsonExtension): void
NIM客户端手动重连（注意 APP需要统一处理自动重连/手动重连的回调，因为如果处于某次自动重连的过程中调用手动重连接口，不起作用！）
Parameters
- jsonExtension: string
  json扩展参数（备用，目前不需要）
Returns void
void 无返回值
- Defined in ts/nim/client.ts:150

kickOtherClient

kickOtherClient(clients): void
将本帐号的其他端踢下线
Parameters
- clients: string[]
  设备标识
Returns void
bool 检查参数如果不符合要求则返回失败, 接口调用成功后的结果通过注册RegKickOtherClientCb回调得到
- Defined in ts/nim/client.ts:158

setMultiportPushConfigAsync

setMultiportPushConfigAsync(switch_on, cb, jsonExtension): Promise<[NIMResCode, boolean]>
(全局回调)设置多端推送
Parameters
- switch_on: boolean
  开关
- cb: null | MultiportPushConfigCallback
  回调函数
- jsonExtension: string
  json扩展参数（备用，目前不需要）
Returns Promise<[NIMResCode, boolean]>
void
Note
```
200:成功
```
- Defined in ts/nim/client.ts:172

getMultiportPushConfigAsync

getMultiportPushConfigAsync(cb, jsonExtension): Promise<[NIMResCode, boolean]>
获得多端推送设置
Parameters
- cb: null | MultiportPushConfigCallback
  回调函数
- jsonExtension: string
  json扩展参数（备用，目前不需要）
Returns Promise<[NIMResCode, boolean]>
void
- Defined in ts/nim/client.ts:192

getSDKVersion

getSDKVersion(): string
获取SDK版本号

Returns string
string 版本号
- Defined in ts/nim/client.ts:206

getServerCurrentTime

getServerCurrentTime(cb, calcLocal): Promise<[number, boolean, number]>

获取当前服务器时间

Parameters

cb: null | GetCurrentServerTimeCallback
操作结果的回调函数
calcLocal: boolean

Returns Promise<[number, boolean, number]>

void

Note

由于网络上/下行的原因，返回的时间会存在一定误差，
当 calc_local == false 时,如果跟上次调用该方法的时间间隔小于1000ms，SDK会采用 calc_local == true
时的方案以减少服务端的压力，并会在回调中指明返回的时间是由本地计算的。 如果返回 code != 200,同样会返回一个本地计算结果

getCurrentUserAccount

getCurrentUserAccount(): string
获取当前登录的用户账号(accid)

Returns string
string 当前登录的用户账号(accid)

Note
没有登录时将返回空字符串
- Defined in ts/nim/client.ts:235

Class NIMClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NIMClient

Properties

client

Methods

eventNames

Returns (keyof NIMClientEvents)[]

listeners

Type Parameters

Parameters

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

listenerCount

Parameters

Returns number

emit

Type Parameters

Parameters

Returns boolean

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

Parameters

Returns void

Returns this

removeListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

removeAllListeners

Parameters

Returns this

initEventHandlers

Returns void

init

Parameters

Returns boolean

login

Parameters

Returns Promise<[LoginRes]>

Note

logout

Parameters

Returns Promise<[NIMResCode]>

Note

cleanup

Parameters

Returns void

getSDKConfig

Returns SDKConfig

getLoginState

Parameters

Returns NIMLoginState

relogin