CustomerIOCommon 3.3.3

CustomerIOCommon 3.3.3

×

由 CustomerIO Engineering 维护。

CustomerIOCommon 3.3.3

  • 由
  • CustomerIO 团队

启动人们喜欢接收的自动化通信。

min swift version is 5.3 min ios version is 13 Contributor Covenant codecov

Customer.io iOS SDK

这是 Customer.io 的官方 iOS SDK。

您可以在 https://customer.io/docs/sdk/ios/ 找到我们的完整 SDK 文档。本 readme 文件只包含帮助您安装和初始化 SDK 的基本信息。

SDK 已在 iOS 设备上进行测试。它可能在其他 Apple 设备（macOS、tvOS 和 watchOS）上运行，但我们尚未正式测试，也不官方支持非 iOS 设备。

还在使用 SDK 的 1.0 版本？

建议升级到使用 iOS SDK 的 2.0 版本。请参考我们的迁移文档来了解如何更新您的应用程序。

总结

要开始，您需要在项目中安装并初始化相关 SDK 包。

我们将SDK拆分为包以最小化对您应用大小的冲击。您只需安装为您的项目需要的包。

包 是否必需？ 描述
跟踪 是 identify 用户/设备并发送事件（用于触发活动、跟踪指标等）
消息推送APN 否 使用苹果的推送通知服务（APNs）发送推送和丰富推送通知。
消息推送FCM 否 使用Firebase云消息（FCM）发送推送和丰富推送通知。

提示：查看我们的示例iOS应用，Remote Habits，了解使用我们SDK的实际案例。

安装SDK

按照苹果的指示，将 https://github.com/customerio/customerio-ios.git 添加为项目依赖，并在Xcode中选择您想要安装的包产品。

我们建议您将依赖规则设置为到下一个主要版本版。虽然我们鼓励您保持您的应用与最新SDK同步，但主要版本可能会包含需要您注意的破坏性更改或新功能。

in XCode select up to next major version when installing the SDK

初始化SDK

在您开始使用Customer.io SDK之前，您需要初始化它。初始化SDK之前对SDK所进行的任何调用都将被忽略。

要开始，请在AppDelegate的application(_ application: didFinishLaunchingWithOptions)函数中初始化SDK。

import CioTracking

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
    ) -> Bool {
        CustomerIO.initialize(siteId: "YOUR SITE ID", apiKey: "YOUR API KEY", region: Region.EU) { config in 
          // optionally, configure the SDK for your app's needs
        }

        return true
    }
}

接下来，当您想要使用SDK的任何功能时，您可以使用该类的共享实例。

CustomerIO.shared.track(...)
MessagingPush.shared.application(...)

更多信息

请参阅我们的完整SDK文档https://customer.io/docs/sdk/ios/

参与贡献

感谢您对我们项目的兴趣！我们欢迎您的贡献。请查阅开发说明来设置您的环境，并开始参与贡献。

注意：我们珍视一个开放、友好、多元化、包容和健康的社区。我们希望所有贡献者遵守我们的行为准则。

许可协议

MIT