Swift 应用开发的 Appeal SDK
呼吁
Appeal 设想为一系列可简化 iOS 开发者与用户之间沟通的工具。目前来看,Appeal 是 What’s New 屏幕的一个单一集成,让开发者能够告知用户应用最新版本中的更新。
警告
Appeal 仍处于开发早期阶段。请谨慎使用。当引入重大变更时,将提供迁移指南。
安装
📱 Appeal Swift 客户端
Appeal 可通过 Swift 包管理器获取:
- 在 Xcode 中,转到文件 → 添加包...
- 在搜索字段中输入
https://github.com/appeal2/appeal-swift-client.git
。 - 将依赖规则设置为最高主要版本,然后按添加包
请注意:目前客户端尚未集成 UIKit。
💻 macOS 仪表板
获取 macOS 应用,以进行测试,以创建账户、管理应用和版本。
初始化
- 在 macOS 仪表板中创建一个应用,然后复制应用 ID。
- 在创建应用时会显示应用 ID。你也可以右键单击边栏中的应用名称,然后从菜单中选择应用 ID,以访问它。
- 导入 Appeal,并在 SwiftUI 应用初始化时对其进行初始化:
import SwiftUI
import Appeal
@main
struct AppealDemo: App {
init() {
let config = AppealConfiguration(appId: "<#APP_ID#>")
Appeal.initialize(with: config)
}
var body: some Scene {
WindowGroup {
ContentView()
}
}
}
- 将
.withWhatsNew()
视图修改器添加到你觉得适合覆盖 What’s New 屏幕的视图。例如,你可能希望将它附加到经过身份验证后用户看到的第一个视图。这样,更新便会出现在核心用户体验的开始部分,而不会中断身份验证和入职流程。
struct NavigationManager: View {
@State var user: User?
var body: some View {
if let user {
MainAppManager()
.withWhatsNew() // ← Shown to authenticated users
} else {
AuthenticationManager()
}
}
}
用法
- 在 macOS 客户端创建应用的新版本时,指定你要在其中显示 What’s New 屏幕的应用目标版本。版本在 Xcode
<#APP_TARGET#> → 常规 → 标识 → 版本
中定义 - 为 macOS 客户端中新创建的版本添加功能。
- 使用指定的版本构建你的应用。
- 默认情况下,对于设备上每个新版本的应用,仅显示一次 What’s New 视图。你可以配置 Appeal 客户端,使其在构建配置设置为调试时,每次启动时显示 What’s New:
let config = AppealConfiguration(appId: "<#APP_ID#>", persistInDebug: true)
- 此设置不影响 AppStore 构建。你的用户将始终仅一次看到最新的可用 What’s New 屏幕。