AppcuesNotificationService 4.0.0-beta.1

AppcuesNotificationService 4.0.0-beta.1

×

由 Appcues 维护。

AppcuesNotificationService 4.0.0-beta.1

  • 由
  • Appcues

AppcuesKit

Appcues iOS SDK

CircleCI Cocoapods License: MIT

Appcues iOS SDK 允许您将 Appcues 体验集成到您的原生 iOS 和 iPadOS 应用中。

SDK 是一个 Swift 库，用于向 Appcues API 发送用户属性和事件，并根据这些属性和事件检索和渲染 Appcues 内容。

🚀 入门

安装

将 Appcues iOS SDK 包添加到您的应用程序中。有几个受支持的安装选项。还有一个可用于参考的教程视频，显示使用 Swift Package Manager 进行安装的示例。

Segment

Appcues 支持与 Segment 的 analytics-swift 库集成。要使用 Segment 安装，您将使用 Segment Appcues 插件。

Swift 包管理器

在 Xcode 中将 Swift 包作为依赖项添加到项目中

  1. 在 Xcode 中，打开您的项目并转到 文件 → 添加包…
  2. 输入包 URL https://github.com/appcues/appcues-ios-sdk
  3. 对于 依赖规则，选择 至下一个主要版本
  4. 点击 添加包

或者，如果您的项目有一个 Package.swift 文件，您可以将 Appcues iOS SDK 添加到依赖项中

dependencies: [
    .package(url: "https://github.com/appcues/appcues-ios-sdk", from: "3.0.0"),
]

CocoaPods

  1. 在 Podfile 中添加 pod
    pod 'Appcues'
  2. 在终端中运行
    pod install

XCFramework

每个 发行版 都附带了 XCFramework。

  1. 下载附在 最新发布版 中的 AppcuesKit.xcframework.zip 并解压。
  2. 在 Xcode 中打开您的项目，转到 文件 → 将文件添加到 “<项目>”…
  3. 在文件导航器中找到 XCFramework 并选择它
  4. 确保选中了“如需要则复制项目”选项，并且选择了您的应用程序的目标
  5. 点击 添加
  6. 在 项目导航器 中选择您的项目，然后选择您的应用程序目标，然后选择 通用 选项卡。在 框架、库和嵌入式内容 下，将 AppcuesKit.xcframework 设置为 嵌入并签名

一次性设置

安装包后，您可以通过使用 import AppcuesKit 导入包来引用 Appcues iOS SDK。

初始化 SDK

当您的应用程序启动时应该初始化 Appcues iOS SDK 实例。例如，application(_:didFinishLaunchingWithOptions:) 生命周期方法。

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
  let appcuesConfig = Appcues.Config(
    accountID: <#APPCUES_ACCOUNT_ID#>,
    applicationID: <#APPCUES_APPLICATION_ID#>)
    
  appcues = Appcues(config: appcuesConfig)
}

初始化 SDK 需要您提供两个值，一个 Appcues 账户 ID 和一个 Appcues 移动应用程序 ID。您可以从您的 Appcues 设置 中获取这些值。有关更多信息，请参阅有关 在 Studio 中注册您的移动应用程序 的帮助文档。

支持构建器预览和屏幕捕获

在安装过程中，请按照配置Appcues URL方案中概述的步骤进行操作。这对于完整的Appcues构建体验是必要的，包括支持体验预览、屏幕截图和调试。有关使用Appcues调试器的详细信息，请参阅调试指南。

识别用户

为了在正确的时间和针对正确的用户定位内容，您需要识别用户并发送有关他们的Appcues数据。用户通过唯一ID进行识别。

  • identify(userID:)

识别用户后，您可以选择将该用户与组相关联。

  • group(groupID:)

跟踪屏幕和事件

事件是您的用户在您的应用程序中采取的“操作”，可以是点击某个按钮到查看特定屏幕等各种操作。一旦您已安装并初始化Appcues iOS SDK，您就可以使用以下方法开始跟踪屏幕和事件

  • track(name:)
  • screen(title:)

锚点工具提示

锚定提示使用元素定位直接指向您应用程序中的特定视图。有关如何配置应用程序视图以进行元素定位的更多信息，请参阅锚定提示指南。

嵌入式体验

在您的应用程序布局中添加AppcuesFrameView实例，以支持嵌入式体验内容的非模态展示。有关如何配置应用程序布局以使用框架视图的更多信息，请参阅配置Appcues框架指南。

有关更多详细信息，请参阅完整的入门指南。

📝 文档

SDK文档可在https://appcues.github.io/appcues-ios-sdk/documentation/appcueskit找到，完整的Appcues文档可在https://docs.appcues.com/找到。

🎬 示例

存储库中的Examples目录包含演示不同安装方法和提供Appcues API使用参考文献的完整iOS应用程序示例。

👷 贡献

查看贡献指南了解如何为开发设置和如何为项目做出贡献。

📄 许可证

本项目采用MIT协议授权。有关更多信息，请参阅LICENSE。