集成方式

NIM SDK 需要您通过手动下载 SDK, 然后添加到您的项目中。

下载SDK

引入SDK

SDK选择

SDK引入方式

<!-- 例如 -->
<script src="NIM_Web_SDK.js">
<script>
  var nim = SDK.NIM.getInstance({
    // ...
  })
</script>

SDK在工程中调用示例：

  // 使用示例
  import SDK from 'NIM_Web_SDK.js'
  const nim = SDK.NIM.getInstance({
    // ...
  })

相对应Webpack配置

  // Webpack 参考配置
  module: {
    rules: [
      {
        test: /\.js$/,
        loader: 'babel-loader',
        exclude: /NIM_Web_SDK.*\.js/,
        query: {
          presets: [
            // ...
          ],
          // ...
        }
        // ...
      },
      // ...
    ],
    // ...
  }

使用说明

实例调用方式

所有业务均通过 NIM SDK 单例调用

  // 引入SDK类的引用以后，获取SDK对象实例
  var nim = SDK.NIM.getInstance({
    // ...
  })

以发送点对点消息为例：

  var msg = nim.sendText({
    scene: 'p2p',
    to: 'account',
    text: 'hello',
    done: function sendMsgDone (error, msg) {
      // ...
    }
  })

事件通知方式

SDK 通过两种方式通知上层 API 调用结果：回调(callback)和委托 (delegate)，两种方式都只在主线程触发(为保证浏览器兼容性，没有使用web worker)。

  // 委托通知示例
  var nim = NIM.getInstance({
    // ... 此处省略其他配置
    onmsg: function (msg) {
      // 此处为委托消息事件，消息发送成功后，成功消息也在此处处理
    }
  })
  // 回调通知示例
  var msg = nim.sendText({
    scene: 'p2p',
    to: 'account',
    text: 'hello',
    done: function sendMsgDone (error, msg) {
      // 此处为回调消息事件，仅仅通知开发者，消息是否发送成功
    }
  })

浏览器兼容性

云信 Web SDK (不包含实时音视频)兼容到 IE8

数据库兼容性

在支持数据库的浏览器上 SDK 会将数据缓存到数据库中, 后续同步都是增量更新, 加快初始化速度。

Web SDK在底层使用了indexedDb，作为数据库进行存储。由于浏览器兼容性及其本身设计上的限制/缺陷（如读写库性能问题、数据空间、没有数据库表级别锁、不能只修改对象单个字段、非阻塞等等问题），用户场景没有强烈需要本地数据存储的应用，不建议开启数据库。

是否支持数据库

// 通过此 `boolean` 值来查看 SDK 在某个浏览器上是否支持数据库
NIM.support.db

其原理是结合了JavaScript"鸭子类型"探测和UserAgent识别，做判断，所以非法改写的UserAgent可能会导致报错。

不使用数据库

如果开发者不想使用数据库, 那么可以设置初始化参数db为false来禁用数据库

var nim = NIM.getInstance({
    db: false
});

依赖说明