提供人们乐于接收的自动化通信。
Customer.io iOS SDK
这是官方的 Customer.io iOS SDK。
您可以在 https://customer.io/docs/sdk/ios/ 找到我们的完整 SDK 文档。本段的目的是只提供安装和初始化 SDK 的基本信息。
SDK 已在 iOS 设备上进行测试。它可能在其他 Apple 设备(macOS、tvOS 和 watchOS)上也能工作,但我们未对其进行官方测试,也不支持这些非 iOS 设备。
在用 SDK 的 1.0 版本吗?
推荐升级到 iOS SDK 的 2.0 版本。请查看我们的迁移文档,了解如何更新您的应用程序。
总结
要开始,您需要在项目安装和初始化相关的 SDK 包。
我们将 SDK 分离成包,以最小化对您应用程序大小的影响。您只需安装项目需要的包。
包 | 必需? | 描述 |
---|---|---|
追踪 | 是 | identify 人员/设备并发送事件(以触发活动、跟踪指标等)。 |
消息推送APN | 否 | 使用 Apple 的推送通知服务(APNs)进行 推送 和 富推送 通知。 |
消息推送FCM | 否 | 使用 Firebase Cloud Messaging (FCM) 进行 推送 和 富推送 通知。 |
提示:查看我们的iOS 示例应用(Remote Habits),了解使用我们的 SDK 的实际情况。
安装 SDK
按照 Apple 的说明,在 Xcode 中将 https://github.com/customerio/customerio-ios.git
添加为项目依赖,并选择要安装的各个 包产品。
我们建议将依赖规则设置为“到下一个主要版本”。虽然我们鼓励您使用最新的 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/
贡献
感谢您对我们项目的关注!我们欢迎您的贡献。查看 我们的开发指南 以设置您的环境并开始贡献。
注意:我们重视这个项目的开放、友好、多元、包容和健康社区。我们期望所有贡献者遵守我们的 行为准则。