Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NIMInterface

NIM 实例连接的基础接口定义

Hierarchy

  • NIMInterface

Implemented by

Index

Methods

Methods

connect

  • connect(): void

  • 使用 disconnect 方法登出IM后，可以调用 connect 重新登录。调用 getInstance 后会自动建立长连接，无需调用 connect

    关联函数

    示例

    nim.disconnect({
      done: function() {
        nim.connect()
      }
    })

    Returns void

destroy

  • destroy(options: { done?: any }): void

  • 断开IM连接，并销毁IM实例。销毁实例后，无法调用 connect 重新连接。

    注意，在9.9.0以及之前版本，调用 destroy 后，会直接触发 ondisconnect 回调函数，但此时长连接并未真正销毁。只有在 done 回调触发时才能保证长连接真正销毁。为了避免重连时多端互踢，用户应该在 destroy 的 done 回调中设置重连等操作

    关联函数

    Parameters

    Returns void

disconnect

  • disconnect(options: { done?: any }): void

  • 断开IM连接，但不销毁IM实例。调用 connect 重新登录后，会基于实例状态增量同步数据

    注意，在9.9.0以及之前版本，调用 destroy 后，会直接触发 ondisconnect 回调函数，但此时长连接并未真正销毁。只有在 done 回调触发时才能保证长连接真正销毁。为了避免重连时多端互踢，用户应该在 destroy 的 done 回调中设置重连等操作

    关联函数

    注意事项

    Parameters

    Returns void

getLoginStatus

  • getLoginStatus(): number

  • 获取当前登录状态. 稳定版自 8.9.127 以及 主干版本 9.16.2 起支持

    注1: 0 的未登录包含了初始状态和登录失败的状态

    注2: 3 的处于重连退避间隔中, 开发者不需要重新调用登录接口, 到期后 SDK 会自动重连.

    Returns number

    返回当前登录状态. 0: 未登录, 1: 已登录, 2: 登录中, 3: 处于重连退避间隔中.

kick

  • kick(options: { deviceIds: []; done?: any }): void

logout

  • logout(): void
  • deprecated

    退出登录。

    注：SDK 版本 v9.6.0 以下推荐先调用 logout 再调用 disconnect/destroy 来保证退出。v9.6.0 及以上不需要调用这个 API，disconnect/destroy 断开前会自动调用。

    Returns void

setOptions

  • 更新原 NIM 实例的初始化参数配置，可配置的参数与 NIM.getInstance 方法的可配置的参数相同。

    使用场景

    任何需要更新初始化参数配置的场景。例如：

    • 采用动态 token 登录时，可通过该 API 更新动态 token。
    • 采用静态 token 登录时，如果需要刷新了静态 token，可通过该 API 更新静态 token。

    IM 登录相关详情，请参见初始化并登录 IM。

    Parameters

    Returns void

setPowerMonitorStatus

  • setPowerMonitorStatus(status: 0 | 1): void

  • 设置休眠状态

    Parameters

    • status: 0 | 1

      休眠状态，默认为 0，不休眠。

      • 0: 不休眠
      • 1: 休眠

    Returns void