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