初始化 Windows/macOS SDK

更新时间: 2024/03/13 15:48:23

本文提供初始化 NetEase IM SDK V10(以下简称 NIM SDK)的详细说明。

功能介绍

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

初始化时,可配置 APNs 离线推送服务、会话已读多端同步、群消息已读和融合存储等重要功能。

前提条件

开始 NIM SDK 的初始化前,请确保已集成 SDK

实现初始化

步骤 1:引入 SDK 动态库文件

将 V10 NIM SDK 提供了不同平台的动态库文件,不同平台下的区别如下:

  • Windows 下后缀为 .dll,您需要将动态库文件放置到应用程序相同目录。
  • macOS 下后缀为 .dylib,您需要在打包应用时将 .dylib 文件放置到 YouApp.app/Contents/Frameworks 目录下。
  • Linux 下后缀为 .so,与 Windows 一样与应用程序放置到同一个目录下即可。

Windows SDK 基于 MSVC15(2017) 开发,如果 App 没有对应的运行时库文件,请在安装应用时部署微软提供的 MSVC 2017 运行时库组件

步骤 2(可选):配置初始化可选项

您可按需对初始化的可选项进行配置。

可选项(如果不配置,将使用默认配置)主要分为:

步骤 1:调用初始化接口

调用 init 方法初始化 SDK,推荐在应用程序启动时初始化。初始化成功后,即可使用 V10 所有的 API。

  • 参数说明:
参数 类型 必填 说明
option V2NIMInitOption V10 初始化配置参数。
  • V2NIMInitOption 参数说明:
参数 类型 必填 说明
appkey nstd::string 云信应用的 AppKey。
appDataPath nstd::string 应用的数据目录,为空则使用默认目录。
默认数据:
  • Windows:%localappdata%/NIM
  • macOS:~/Library/Application Support/NIM
  • Linux:~/.local/share/NIM
  • basicOption V2NIMBasicOption 基础配置。
    linkOption V2NIMLinkOption 连接相关配置。
    databaseOption V2NIMDatabaseOption 数据库配置。
    fcsOption V2NIMFCSOption 融合存储配置。
    privateServerOption nstd::optional<V2NIMPrivateServerOption> 私有化配置。
    • 示例代码:
    cppint main(int argc, char* argv[]) {
        v2::V2NIMInitOption option;
        auto error = v2::V2NIMClient::get().init(option);
        if (error) {
            // handle error
            return -1;
        }
        error = v2::V2NIMClient::get().uninit();
        if (error) {
            // handle error
            return -1;
        }
        return 0;
    }
    

    后续步骤

    完成初始化后,可登录 IM

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能介绍
    • 前提条件
    • 实现初始化
    • 步骤 1:引入 SDK 动态库文件
    • 步骤 2(可选):配置初始化可选项
    • 步骤 1:调用初始化接口
    • 后续步骤