官方Demo下载地址Feature-Rich App, 建议学者下载此Demo参考。
当用户调用App Clip时,操作系统会对App Clip进行验证。然后,当用户启动app clip时,系统将调用的URL提供给App Clip。
配置调用的URL
App Clip和主应用都需要响应调用的URL并更新用户界面以提供平滑的启动。例如,考虑一个有多个地理位置的企业app clip。您可以配置业务域https://example.com到启动App Clip并要求用户从列表中选择一个地理位置,但这样做会导致额外的操作步骤,从而减慢用户的速度,影响用户体验。你可以通过配置调用的URL,并在调用中传递额外的URL参数来避免这额外的操作步骤。
配置调用App Clip和主应用的URL:
- 声明Associated Domains capability并为启动App Clip的每个域添加条目。
- 保存未保存的数据,以防用户从一个位置切换到另一个位置。
- 使用包含其他参数的URL;例如https://example.com/location1, https://example.com/location2,等等。
- 启动时,响应url并根据参数更新用户界面。
例如:你可以注册https://example.com/menu作为高级应用商店体验的URL。对于来自NFC tag的调用,可以使用类似于https://example.com/menu/dinner/item/1234或者https://example.com/menu/dinner/item/5678。但是,你的App Clip和主应用也必须能够处理https://example.com/menu。
更多资料可以参考创建一个App Clip、配置App Clip启动体验。
App Clip处理URL
当用户启动一个app clip时,你可以通过这个个NSUserActivity
对象来响应调用App Clip的URL。
Important
当用户安装主应用替代了App Clip,用户通过调用URL就会调用主应用了,所以主应用程序也必须处理所有调用URL,并包含App Clip的功能。
要持久化任何状态和数据,并在启动时访问NSUserActivity对象,请执行以下操作:
- 对于基于SwiftUI的app clip和主应用,实现SwiftUI的生命周期回调;例如,使用onContinueUserActivity(:perform:)。
- 对于基于UIKit的App Clip和支持scene-based的应用程序生命周期事件的主应用,实现UISceneDelegate中定义的回调。例如,scene(:willConnectTo:options:), scene(:willContinueUserActivityWithType:), scene(_:continue:), 等。
- 对于基于UIKit的App Clip和响应app-based 的生命周期事件的主应用,请实现UIApplicationDelegate中定义的回调。确保实现application(:continue:restorationHandler:)回调,因为你没有权限访问application(:didFinishLaunchingWithOptions:)中的NSUserActivity对象。
启动App Clip时,确保调用类型为NSUserActivityTypeBrowsingWeb,然后访问启动App Clip的URL。以下代码显示了从调用URL提取组件的函数:
func respondTo(_ activity: NSUserActivity?) {
// Guard against faulty data.
guard activity != nil else { return }
guard activity!.activityType != NSUserActivityTypeBrowsingWeb else { return }
guard let incomingURL = activity?.webpageURL else { return }
guard let components = NSURLComponents(url: incomingURL, resolvingAgainstBaseURL: true) else { return }
// Update the user interface based on URL components passed to the app clip.
}
确认用户的物理位置
如果创建用户在物理位置调用的App Clip,则可能需要在允许用户执行任务之前确认用户的位置。
为了快速启动,app clips可以使用轻量级机制,在该机制中,系统会验证用户是否位于特定的预期位置:
- 在app clip的info.plist文件中加NSAppClip key,设置它的类型为Dictionary,包含通知权限
NSAppClipRequestEphemeralUserNotification
和 位置权限NSAppClipRequestLocationConfirmation
- 在NSAppClip添加NSAppClipPrequestLocationConfirmation,其类型为Boolean,然后将其值设置为true。你不需要将此项添加到主应用的info.plist。 当用户安装主应用来替换App clip时,系统允许主应用确认用户的位置,因为App Clip已经允许这样做。
- 向App Clip提供预期的物理位置信息。在启动App clip时可以检索URL中编码id,并使用该id在数据库中查找企业的位置信息。或者,你可以在启动App Clip的URL中对位置信息本身进行编码。
- 使用位置信息,会创建一个半径最大为500米的CLCircularRegion对象,其值并通过
confirmAcquired(in:completionHandler:)
方法回调回来。
App Clip的info.plist添加将NSAppClipPrequestLocationConfirmation,调用app clip时系统桌面显示的app clip card会包含一个附加说明,告诉用户app clip可以访问他们的位置。默认情况下启用此权限,但用户可以通过点击app clip card的说明来禁用它。
当用户启动App Clip时,下面的代码验证用户的位置。确保为每个可能的结果更新用户界面,包括用户拒绝访问其设备上的位置服务的情况。
import UIKit
import AppClip
import CoreLocation
class SceneDelegate: UIResponder, UIWindowSceneDelegate {
var window: UIWindow?
// Call the verifyUserLocation(_:) function in all applicable life-cycle callbacks.
func verifyUserLocation(_ activity: NSUserActivity?) {
// Guard against faulty data.
guard activity != nil else { return }
guard activity!.activityType != NSUserActivityTypeBrowsingWeb else { return }
guard let payload = activity!.appClipActivationPayload else { return }
guard let incomingURL = activity?.webpageURL else { return }
// Create a CLRegion object.
guard let region = location(from: incomingURL) else {
// Respond to parsing errors here.
return
}
// Verify that the invocation happened at the expected location.
payload.confirmAcquired(in: region) { (inRegion, error) in
guard let confirmationError = error as? APActivationPayloadError else {
if inRegion {
// The location of the NFC tag matches the user's location.
} else {
// The location of the NFC tag doesn't match the records;
// for example, if someone moved the NFC tag.
}
return
}
if confirmationError.code == .doesNotMatch {
// The scanned URL wasn't registered for the app clip.
} else {
// The user denied location access, or the source of the
// app clip’s invocation wasn’t an NFC tag or visual code.
}
}
}
func location(from url:URL) -> CLRegion? {
let coordinates = CLLocationCoordinate2D(latitude: 37.334722,
longitude: 122.008889)
return CLCircularRegion(center: coordinates,
radius: 100,
identifier: "Apple Park")
}
}
本地测试App Clip的启动
添加一个环境变量并在本地调试app clip调用的URL,测试app clip对调用的URL的响应是非常重要的。
测试App Clip的调用:
在Xcode中,选择Product > Scheme > Edit Scheme,然后选择你的App clip的scheme。
选择run > Arguments。
-
在Arguments选项中,添加一个新的environment variable,命名为— _XCAppClipURL,将其值设置为你要测试的URL,然后勾上选项。将app clip target添加到你的项目中时,Xcode会为你添加此环境变量。
-
你要测试的URL的域名需要是你Associated Domains中的设置的域名。
build 运行App Clip从NSUserActivity对象测试配置的URL。