提供人们喜欢接收的自动化通讯。
Customer.io iOS SDK
这是Customer.io的官方iOS SDK。
我们的完整的SDK文档可在https://customer.io/docs/sdk/ios找到。本README只包含基本的安装和初始化信息。
该SDK已在iOS设备上进行了测试。它可能在其他Apple设备(如macOS、tvOS和watchOS)上也能工作,但我们尚未对这些设备进行官方测试,也不提供官方支持。
使用我们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保持您的应用更新,但主要版本可能包含需要您注意的破坏性更改或新功能。
初始化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/
贡献
感谢您对项目的关注!我们欢迎您的贡献。请查看我们的开发说明以设置您的开发环境并开始贡献。
注意:我们重视本项目的一个开放、友好、多样、包容、健康的社区。我们期望所有贡献者遵循我们的行为准则。