uni-app x

更新时间: 2026/08/13 14:48:33

本文介绍如何初始化 NIM uni-app x V10 系列网易云信即时通讯 SDK(简称 NIM SDK)。

调用时机

对 NIM SDK 进行初始化的时机,是在调用各项即时通讯功能之前。一般情况下,在应用的生命周期内,仅需进行一次初始化。

前提条件

初始化 NIM uni-app x SDK 前,请确保您已经完成了以下操作:

初始化

调用 initNIMSDK 方法创建实例并实现初始化。

  • 初始化模块负责在应用启动阶段初始化云信 IM SDK,并通过 callback 返回初始化结果。
  • NIMInitOptions.options 使用 SDKOptions,iOS 平台还额外支持 IOSSDKOptions 中的专有字段。

参数说明

TypeScriptinitNIMSDK(options: NIMInitOptions): void

NIMInitOptions 的配置参数:

字段 类型 必填 说明
options SDKOptions SDK 初始化配置。
success (res: NIMInitSuccess) => void 初始化成功回调。
fail (res: NIMFail) => void 初始化失败回调。
complete (res: NIMInitSuccess \| NIMFail) => void 初始化完成回调,成功或失败都会触发。

SDKOptions 的配置参数:

字段 类型 必填 说明
appKey string 云信 SDK AppKey。

示例代码

TypeScriptimport { initNIMSDK } from '@/uni_modules/nim-uts-sdk'

initNIMSDK({
  options: {
    appKey: 'your_app_key'
  },
  success: (res) => {
    console.log('init success', res.appKey, res.sdkVersion)
  },
  fail: (err) => {
    console.log('init fail', err.errCode, err.errMsg)
  },
  complete: (res) => {
    console.log('init complete', res)
  }
})

下一步

完成初始化后,您可以尝试 登录 IM

此文档是否对你有帮助?
有帮助
去反馈
  • 调用时机
  • 前提条件
  • 初始化
  • 参数说明
  • 示例代码
  • 下一步