集成 SDK

更新时间: 2024/03/11 17:18:28

NetEase Instant Messaging Electron SDK(以下简称为 NIM Electron SDK)封装了 NIM PC SDK,同时具有原生平台性能,为 Electron 应用提供完善的即时通信功能开发框架。您可以在前端框架中使用 PC 端所有功能,通过简洁的 API 调用快速实现即时通信功能。

本文介绍如何快速将 NIM SDK 集成到您的 Electron 项目中。

开发环境要求

  • Electron 8.5.5 及以上版本
  • Node.js 12.13.0 及以上版本
  • 各端开发环境要求:
平台 架构 版本
Windows x64/IA-32 Windows 7 及以上
macOS x64/arm64 10.14.0 及以上
Linux x64/arm64 glibc 2.23 及以上

集成步骤

步骤1:安装 NIM SDK 及依赖

打开终端并进入您的项目目录,执行以下命令安装 node-nim 模块:

npm install node-nim --save-dev

安装完成后,您可以在当前目录下看到一个名为 node_modules 的文件夹,其中包含了 node-nim 模块及其所有依赖项。

如果您需要在 x64 平台上构建 IA-32 应用程序或类似操作,可以使用 --arch--platform 参数来指定要构建的平台。

Windows x64
npm install node-nim --save-dev --arch=x64 --platform=win32
windows x86
npm install node-nim --save-dev --arch=ia32 --platform=win32
macOS x64
npm install node-nim --save-dev --arch=x64 --platform=darwin
macOS arm64
npm install node-nim --save-dev --arch=arm64 --platform=darwin
Linux x64
npm install node-nim --save-dev --arch=x64 --platform=linux
Linux arm64
npm install node-nim --save-dev --arch=arm64 --platform=linux

步骤2:导入 NIM 模块

在 js 文件中添加以下 import 代码,将 NIM 模块导入到您的项目。

import * as node_nim from 'node-nim'

后续步骤

完成 SDK 集成后,需进行初始化

相关参考

示例项目

云信在 Github 上提供了开源的示例项目,为您后续的 IM 集成提供参考。

API 参考

您可以在 Electron SDK API 了解 SDK API 信息。

此文档是否对你有帮助?
有帮助
去反馈
  • 开发环境要求
  • 集成步骤
  • 步骤1:安装 NIM SDK 及依赖
  • 步骤2:导入 NIM 模块
  • 后续步骤
  • 相关参考
  • 示例项目
  • API 参考