跳到主要内容

导入 SDK

您可以选择如下任意一种方式：

  • 使用 CocoaPods 添加远程依赖项，导入 Framework
  • 手动导入 Framework。
  • 5.12.2 版本开始，支持通过 Swift Package Manager 的方式导入 IMLib SDK。

环境要求​

  • Xcode 需要使用 Xcode 11 及以上的版本。
  • 苹果设备的系统需要使用 iOS 9.0 及以上的版本。
  • 如果您打算通过 CocoaPods 集成 SDK，需要使用 CocoaPods 1.10.0 及以上的版本。这是因为 IMLib SDK 5.1.1 版本后变更为 XCFramework，而 CocoaPods 是从 1.10.0 版本后才完整支持 XCFramework 的集成方式，具体请参见知识库文档。
  • Swift Package Manager 方式需要 Swift 5.0 及以上的版本。

如需安装 CocoaPods 环境，请参照 安装 CocoaPods。

检查版本​

在导入 SDK 前，可以前往融云官网 SDK 下载页面确认当前最新版本号。

CocoaPods​

  1. 如果您的项目中没有 Podfile 文件，您需要打开终端并进入到项目的根目录，在终端中运行 pod init 命令，之后系统会自动创建一个默认的 Podfile 文件，在项目中的 Podfile 文件中添加如下内容：

    ruby
    pod 'RongCloudIM/IMLib', '~> x.y.z'
    提示

    其中 x.y.z 代表 IMLib 具体的版本号，您可以在融云官网 SDK 下载页面或在终端中通过先执行 pod repo update，再执行 pod search RongCloudIM 命令在 CocoaPods 仓库查询 IMLib 最新的版本。

  2. 打开终端并进入到 Podfile 文件所在的目录，在终端中运行以下命令：

    shell
    pod install
    提示

    如果终端中出现类似 CocoaPods could not find compatible versions for 等找不到相关版本的报错，可先在终端中执行 pod repo update 命令，再执行 pod install 命令。

  3. 通过 Xcode 打开项目目录下的 xcworkspace 文件加载工程。

Swift Package Manager​

提示

IMLib SDK 从 5.12.2 版本开始支持 Swift Package Manager 的集成方式。

  1. 打开 Xcode 工程。
  2. 点击 File > Add Package Dependency 选项。
  3. 在弹出框右上角的搜索框中，粘贴入下面的任一一个 URL 地址:
  4. Xcode 将会弹出融云 SDK 的选择列表，其中 IMLibCore 提供核心 IM 能力，其余组件可根据业务类型自行选择。

组件介绍

融云 IM SDK 提供了如下几种组件供开发者选择使用，其中 IMLibCore 为核心组件，其余组件可以根据业务的实际需求组合使用，能力介绍如下：

Swift Package动态库描述
IMLibCoreRongIMLibCore.xcframeworkIM 核心功能.
ChatRoomRongChatRoom.xcframework聊天室功能（包含 IMLibCore）
CustomerServiceRongCustomerService.xcframework客服功能（包含 IMLibCore）
DiscussionRongDiscussion.xcframework讨论组功能（包含 IMLibCore）
PublicServiceRongPublicService.xcframework公众号功能（包含 IMLibCore）

手动集成​

  1. 您可以前往融云官网 SDK 下载页面，将 IMLib SDK 下载到本地。

  2. 使用 Xcode 打开您的工程，然后将下载下来的 SDK 手动拖入到您的项目中，所需的 SDK 如下：

    Framework资源文件
    IMLib
    • RongIMLib.xcframework
    • RongIMLibCore.xcframework
    • RongChatRoom.xcframework
    • RongCustomerService.xcframework
    • RongLocation.xcframework（5.2.5 及之后版本：无需导入）
    • RongDiscussion.xcframework
    • RongPublicService.xcframework
    • RCConfig.plist
    Translation（可选）
    • RongTranslation.xcframework
    提示

    SDK 仅在 5.2.2 及之后版本的支持翻译插件（Translation），并且该插件暂仅适用于使用新加坡数据中心的应用。

  3. 修改您的项目配置。在 General -> Frameworks,Libraries,and Embedded Binaries 中，将手动导入的 IMLib SDK 所有的 Framework 全部改为 Embed & Sign。

最后于 更新