初始化 Windows/macOS SDK

更新时间: 2024/09/11 16:21:52

本文介绍如何初始化适配桌面系统(Windows、macOS、Linux)应用的 V10 系列网易云信即时通讯 SDK(简称 NIM SDK)。初始化 SDK 时,可同时配置 APNs 离线推送服务、会话已读多端同步、群消息已读和融合存储等重要功能。

调用时机

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

前提条件

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

第一步:引入动态库文件

针对桌面系统应用,V10 NIM SDK 提供了不同系统的动态库文件,区别如下:

系统
文件后缀
处理方式
Linux .so 将动态库文件,放置到应用程序相同目录。
macOS .dylib 在打包应用时,将 .dylib 文件放置到 <YourApp>.app/Contents/Frameworks 目录下。
Windows .dll 将动态库文件,放置到应用程序相同目录。Windows SDK 基于 MSVC15(2017) 开发,如果 App 没有对应的运行时库文件,请在安装应用时部署 微软提供的 MSVC 2017 运行时库组件

第二步:配置初始化可选项

您可按需对初始化的可选项进行配置。本步骤为可选步骤,如果不配置,将使用默认配置。

初始化可选项配置主要分为:

第三步:调用初始化接口

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

参数说明

参数 类型 是否必选 说明
option V2NIMInitOption V10 初始化配置参数。

V2NIMInitOption 参数说明:

参数 类型 是否必选 说明
appkey nstd::string 网易云信应用的 AppKey。获取方式请参考 创建应用并获取 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> 私有化配置。

    示例代码

    C++int 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

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用时机
    • 前提条件
    • 第一步:引入动态库文件
    • 第二步:配置初始化可选项
    • 第三步:调用初始化接口
    • 参数说明
    • 示例代码
    • 下一步