CustomerIOMessagingInApp 3.3.3

CustomerIOMessagingInApp 3.3.3

CustomerIO Engineering维护。



  • 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已在iOS设备上进行了测试。可能也适用于其他苹果设备(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保持您的应用程序更新,但主要版本也许包括破坏性更改或需要您注意的新功能。

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

初始化SDK

在您可以使用Customer.io 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