CustomerIOTracking 2.13.2

CustomerIOTracking 2.13.2

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 文档。这个 reademe 仅包含基本信息以帮助您安装和初始化 SDK。

该 SDK 已在 iOS 设备上测试。它可能在其他 Apple 设备—macOS, tvOS 和 watchOS 上工作,但我们尚未官方测试,也不支持非 iOS 设备。

正在使用我们 SDK 的第 1 版?

建议升级到使用 iOS SDK 的第 2 版。查看迁移文档,了解如何更新您的应用程序。

总结

要开始使用,您需要在项目中安装并初始化相关的 SDK 包。

我们将 SDK 分离成包以最小化对您的应用程序大小的影响。您应该仅安装项目所需的包。

必需? 描述
跟踪 使用 identify 识别人员和设备,并通过 发送事件(触发活动、跟踪指标等)。
MessagingPushAPN 使用苹果推送通知服务(APNs)发送 推送丰富推送 通知。
MessagingPushFCM 使用 Firebase Cloud Messaging(FCM)发送 推送丰富推送 通知。

提示:查看我们使用 SDK 的实际示例——我们的 iOS 示例应用,Remote Habits

安装 SDK

按照 Apple 的说明,将 https://github.com/customerio/customerio-ios.git 添加为项目的依赖项,并在 Xcode 中选择您要安装的各个 SDK 产品

我们建议将 依赖规则 设置为 至上一个主要版本。虽然我们鼓励您使用最新 SDK 保持您的应用程序更新,但主要版本可能包含需要您注意的破坏性更改或新功能。

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

初始化 SDK

在使用 Customer.io SDK 之前,您需要对其进行初始化。在初始化 SDK 之前对 SDK 发出的任何调用都将被忽略。

要开始,请在 AppDelegateapplication(_ 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 文档。

贡献力量

感谢您对我们项目的关注!我们欢迎您的贡献。请查阅我们的开发说明,设置好您的环境并开始贡献力量。

注意:我们重视本项目社区的开放性、包容性、多样性、健康性。我们期望所有贡献者遵循我们的行为准则

许可协议

MIT