Intro to Siri Shortcuts

Transcript

1. Intro to Siri Shortcuts Mathis Müller
2. Overview • Rationale • Adopting shortcuts • User Activity • Intents • Demo • More
6. Adopting Shortcuts Define Shortcut Donate Shortcut Handle Shortcut
7. Adopting Shortcuts • Easy to adopt • Just a shortcut to your app • Already used for Handoff & Spotlight • Can run in background • Can show custom UI and custom responses • Allows for better predictions
8. NSUserActivity
9. NSUserActivity 1. Define Shortcut: Declare a user activity type <key>NSUserActivityTypes</key> <array> <string>com.myapp.name.my-activity-type</string> </array>
10. NSUserActivity 2. Donate Shortcut: Create a NSUserActivity object let userActivity = (activityType: "com.myapp.name.my-activity-type") userActivity.isEligibleForSearch = true userActivity.isEligibleForPrediction = true userActivity.title = "Activity" userActivity.userInfo = ["key": "value"] userActivity.suggestedInvocationPhrase = "Let's do it” let attributes = CSSearchableItemAttributeSet(itemContentType: kUTTypeItem as String) let image = UIImage(named: "myImage")! attributes.thumbnailData = image.pngData() attributes.contentDescription = "Subtitle" userActivity.contentAttributeSet = attributes viewController.userActivity = userActivity
11. NSUserActivity 3. Handle Shortcut: Implement the App Delegate method func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool { if userActivity.activityType == "com.myapp.name.my-activity-type" { } // Restore state for userActivity and userInfo }
12. Intents
13. Intents • Can use custom intents or rely on built-in intent-domains (SiriKit) • Should use built-in domains if possible
14. Intents 1. Define the shortcut • Create an intent-definition file
16. Intents • Xcode will generate an Intent and an IntentHandling Protocol public class ViewMagazineIntent: INIntent { public var magazine: INObject? } public protocol ViewMagazineIntentHandling: NSObjectProtocol { public func handle(intent: ViewMagazineIntent, completion: @escaping (ViewMagazineIntentResponse) -> Void) optional func confirm(intent: ViewMagazineIntent, completion: @escaping (ViewMagazineIntentResponse) -> Void) }
17. Intents 2. Donate the shortcut let viewMagazineIntent = ViewMagazineIntent() viewMagazineIntent.magazine = INObject(identifier: magazine.identifier, display: magazine.title) viewMagazineIntent.suggestedInvocationPhrase = "Show Magazine!" let interaction = INInteraction(intent: viewMagazineIntent, response: nil) interaction.donate { error in guard error == nil else { // Handle errors } }
18. Intents 3. Handle the shortcut (in the app delegate) func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool { if userActivity.activityType == "ShowMagazineIntent", let intent = userActivity.interaction?.intent as? ViewMagazineIntent { // Present magazine, pre-populated with the fields from the intent } }
19. Intents 3. Handle the shortcut (in the background in an extension)
20. Intents 3. Handle the shortcut (in the background in an extension) public class ViewMagazineIntentHandler: NSObject, ViewMagazineIntentHandling { public func confirm(intent: ViewMagazineIntent, completion: @escaping (ViewMagazineIntentResponse) -> Void) { completion(ViewMagazineIntentResponse(code: .ready, userActivity: nil)) } public func handle(intent: ViewMagazineIntent, completion: @escaping (ViewMagazineIntentResponse) -> Void) { guard let magazine = intent.magazine else { completion(ViewMagazineIntentResponse(code: .failure, userActivity: nil)) return } print("Handled magazine with identifier = \(String(describing: magazine.identifier))") completion(ViewMagazineIntentResponse(code: .success, userActivity: nil)) } }
21. (Lots) More • Better suggestion: requiredUserInfoKeys / parameter combinations for intents • Custom results with INObject • Custom UI responses • INPlayMediaIntent for Media. Works on HomePod. • Expose Shortcuts on Siri Watch Face via INRelevantShortcuts • Use INVoiceShortcutCenter to suggest initial shortcuts • INUIAddVoiceShortcutViewController to let the user set a shortcut
22. Tips & Good Practices • Donate shortcuts only once • Privacy: Delete shortcuts when they are no longer needed • Testing: • User the new developer options • Create a custom shortcut in the Shortcuts app
23. Sessions and Resources • Session 211: Introduction to Siri Shortcuts • Session 214: Building for Voice with Siri Shortcuts • Sample Code: Soup Chef • SiriKit Documentation • SiriKit Landing Page • HIG on SiriKit