初始化 Web/uni-app/小程序 SDK

更新时间: 2024/04/16 15:02:01

本文提供初始化 NIM Web SDK 的详细说明。

功能介绍

在使用云信 IM 的各项功能之前,必须先对 NIM SDK 进行初始化。一般情况下,在应用的生命周期内,仅需进行一次初始化。

初始化的模块主要包括:

  • IM 消息
  • 会话
  • 用户资料
  • 好友关系
  • 用户关系
  • 群组

前提条件

开始 NIM Web SDK 的初始化前,请确保:

实现初始化

调用 V2NIM.getInstance 方法创建 NIM 实例,同时配置初始化参数。

如需使用 V10 SDK API,请将 NIMInitializeOptions.apiVersion 设置为 v2

NIM.getInstance 方法为单例模式,对于同一个账号永远返回同一个实例,即只在第一次调用时初始化一个实例,后续调用该方法会直接返回初始化过的实例。如需更新初始化配置,不建议继续调用该方法,具体更新方法参见下文的更新初始化配置

  • 参数说明
getInstance(_options?: NIMInitializeOptions, _otherOptions?: NIMOtherOptions): NIMInterface
参数名称 类型 是否必填 默认值 描述
_options NIMInitializeOptions 见下文 初始化基础配置项
_otherOptions NIMOtherOptions 见下文 初始化其他配置项

NIMInitializeOptions 部分重要参数说明:

其他参数请参见 NIMInitializeOptions

名称 类型 必填 默认值 描述
appkey string - 应用的 App Key,在云信控制台创建应用后获取。
apiVersion string v1 使用 API 版本。
如需使用 V10 SDK 接口,请设置为 v2
debugLevel string off 日志等级。
  • off:不输出任何日志
  • debug:输出所有日志<li>log:输出 log、warn、 error 级别的日志
  • warn:输出 warn、error 级别的日志
  • error:输出 error 级别的日志
  • NIMOtherOptions 部分重要参数说明:

    其他参数请参见 NIMOtherOptions

    名称 类型 必填 默认值 描述
    V2NIMLoginServiceConfig NIMEModuleParamV2Login - 使用 V10 SDK 登录的相关配置项
    cloudStorageConfig NIMEModuleParamCloudStorageConfig - 云存储配置,如需使用融合存储需要提前引入 AWS SDK,并设置 s3 参数。

    NIMEModuleParamV2Login 参数说明:

    名称 类型 必填 默认值 描述
    lbsUrls Array 云信公网提供的链接 lbs 地址。SDK 连接时会向 lbs 地址请求得到 socket 连接地址。
    linkUrl string null socket 备用地址,当 lbs 请求失败时,尝试直接连接 socket 备用地址。
    isFixedDeviceId boolean false deviceId 是否需要固定
    customClientType number 自定义客户端类型
    customTag string 自定义客户端标签
    • 示例代码,浏览器环境,以及uni-app编译为非小程序环境
    typescriptconst nim = NIM.getInstance(
      /**
       * param1: NIMInitializeOptions
       */
      {
        appkey: "YOUR_APPKEY",
        debugLevel: "debug",
        apiVersion: "v2"
      }
    )
    
    • 示例代码,小程序环境,以及uni-app编译为小程序环境:
    typescriptconst nim = NIM.getInstance(
      /**
       * param1: NIMInitializeOptions
       */
      {
        appkey: "YOUR_APPKEY",
        debugLevel: "debug",
        apiVersion: "v2"
      },
       V2NIMLoginServiceConfig: {
        lbsUrls: [
          "https://lbs.netease.im/lbs/wxwebconf.jsp"
        ],
        linkUrl: "wlnimsc0.netease.im"
      },
    )
    

    后续步骤

    完成初始化后,可登录 IM

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能介绍
    • 前提条件
    • 实现初始化
    • 后续步骤