Siri Shortcuts - Swift Heroes, Torino, Italy, November 2018

NSUserActivity SETUP
let userActivity = NSUserActivity(activityType: "com.yourco.YourApp.ActivityType")
userActivity.isEligibleForSearch = true
userActivity.isEligibleForPrediction = true
userActivity.title = "View \(trip.name ?? "") trip"
userActivity.suggestedInvocationPhrase = "View \(trip.name ?? "") trip"
userActivity.requiredUserInfoKeys = [ UserActivityInfoKey.trip.rawValue ]
userActivity.userInfo = [ UserActivityInfoKey.trip.rawValue: trip.id ]
userActivity.persistentIdentifier = trip.id
viewController.userActivity = userActivity
userActivity.becomeCurrent()

View Slide

viewController.userActivity = userActivity // IMPORTANT

View Slide

viewController.userActivity = userActivity // IMPORTANT

View Slide

!
SPOTLIGHT

View Slide

SPOTLIGHT SETUP
let attributes = CSSearchableItemAttributeSet
(itemContentType: kUTTypeContent as String)
if let destination = trip.destination {
attributes.contentDescription = "View details for your trip to \(destination)"
}
attributes.thumbnailData = UIImage(named: "trip")?.pngData()
userActivity.contentAttributeSet = attributes

SPOTLIGHT SETUP
}

SPOTLIGHT SETUP
}

SPOTLIGHT SETUP
}

SPOTLIGHT SETUP
}
// TODO: Y U NO WORK?!

View Slide

SPOTLIGHT SETUP
}
// TODO: Y U NO WORK?!

View Slide

DON'T TRY TO
CRAM WAY TOO MUCH REPETITIVE INFORMATION INTO THE CONTENT DESCRIPTION

View Slide

DON'T TRY TO
CRAM WAY TOO MUCH REPETITIVE INFORMATION INTO THE CONTENT DESCRIPTION
⬆
(LIKE THIS)

View Slide

SPOTLIGHT SETUP
attributes.contentDescription = "\(destination) || \(trip.formattedDateInterval)"
}

View Slide

SPOTLIGHT SETUP
attributes.contentDescription = """
!
\(destination)
"
\(trip.formattedTripInterval)
"""
}

View Slide

HANDLING
SHORTCUT SELECTION

View Slide

UIApplicationDelegate

View Slide

SETUP
func application(_ application: UIApplication,
continue userActivity: NSUserActivity,
restorationHandler:
@escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
guard userActivity.activityType == "com.yourco.YourApp.ActivityType" else {
return false
}
let handlingVC = // Omitted for length
restorationHandler(handlingVC)
return true
}

View Slide

SETUP
restorationHandler:
return false
}
return true
}

View Slide

SETUP
restorationHandler:
return false
}
return true
}

View Slide

SETUP
restorationHandler:
return false
}
return true
}

View Slide

HARD MODE:
Intents FRAMEWORK

View Slide

INIntent
+
INInteraction

View Slide

DONATING AN INTERACTION
let arrivalIntent = ArrivalTimeIntent()
arrivalIntent.origin = plan.originName
arrivalIntent.destination = plan.destinationName
arrivalIntent.suggestedInvocationPhrase = "\(plan.destinationName) arrival"
let arrivalInteraction = INInteraction(intent: arrivalIntent,
response: nil)
arrivalInteraction.donate { error in
if let error = error {
debugPrint("Error donating arrival intent: \(error)")
}
}

response: nil)
}
}

response: nil)
}
}

response: nil)
}
}

response: nil)
}
}

AppDelegate INTENT SETUP
restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
if let arrivalIntent = intent as? ArrivalTimeIntent {
guard let plan = Plan.fromArrivalIntent(arrivalIntent,
in: CoreDataManager.shared.mainContext) else {
return false
}
coordinator.viewPlan(plan)
return true
}
// Else, go through the rest of method we saw earlier
}

View Slide

if let arrivalIntent = userActivity.interaction?.intent as? ArrivalTimeIntent {
return false
}
return true
}
}

View Slide

return false
}
return true
}
}

View Slide

return false
}
return true
}
}

View Slide

return false
}
return true
}
}

View Slide

EXPERT MODE:
RESPONSES + INTENT EXTENSION

View Slide

INTENT HANDLER SETUP
public class ArrivalTimeIntentHandler: NSObject, ArrivalTimeIntentHandling {
// Optional!
public func confirm(intent: ArrivalTimeIntent,
completion: @escaping (ArrivalTimeIntentResponse) -> Void) {
// Figure out if the thing can be done
}
public func handle(intent: ArrivalTimeIntent,
// Do the thing!
completion(.success)
}
}

View Slide

// Optional!
}
// Do the thing!
}
}

View Slide

// Optional!
}
// Do the thing!
}
}

View Slide

guard let plan = Plan.fromArrivalIntent(intent,
if let destination = intent.destination {
completion(.failureNoFuturePlansToDestination(destination))
} else {
completion(ArrivalTimeIntentResponse(code: .failureNoDestination,
userActivity: nil))
}
return
}
completion(.success(destination: plan.destinationName,
method: plan.methodName,
origin: plan.originName,
time: plan.formattedEndTime,
date: .formattedEndDate))
}
}

View Slide

} else {
userActivity: nil))
}
return
}
completion(plan.toArrivalIntentResponse)
}
}

View Slide

} else {
userActivity: nil))
}
return
}
}
}

View Slide

} else {
userActivity: nil))
}
return
}
}
}

View Slide

APP GROUPS AND
SHARED CONTAINERS

View Slide

THINGS TO MOVE TO A CONTAINER
> Core Data
> Keychain
> User Defaults
> Data Caching

View Slide

SETUP INSTRUCTIONS

View Slide

SETUP INSTRUCTIONS
¯\_(ϑ)_/¯

View Slide

GALAXY BRAIN MODE:
IntentsUI EXTENSION

View Slide

INTENT UI SETUP
func configureView(for parameters: Set,
of interaction: INInteraction,
interactiveBehavior: INUIInteractiveBehavior,
context: INUIHostedViewContext,
completion: @escaping (Bool, Set, CGSize) -> Void) {
completion(true, parameters, self.desiredSize)
}
var desiredSize: CGSize {
return self.extensionContext!.hostedViewMaximumAllowedSize
}

INTENT UI SETUP
}
}

INTENT UI SETUP
}
}

INTENT UI SETUP
}
}

INTENT UI SETUP
}
}

INTENT UI SETUP
}
}

INTENT UI SETUP
}
}

INTENT UI SETUP
}
}

var plan: Plan? = nil
let moc = CoreDataManager.shared.mainContext
if let departureIntent = interaction.intent as? DepartureTimeIntent {
plan = Plan.fromDepartureIntent(departureIntent, in: moc)
} else if let arrivalIntent = interaction.intent as? ArrivalTimeIntent {
plan = Plan.fromArrivalIntent(arrivalIntent, in: moc)
}
guard let retrievedPlan = plan else {
completion(false, parameters, .zero)
return
}
let coordinator = EmbeddedPlanCoordinator(plan: retrievedPlan)
coordinator.configureIn(viewController: self)
}
}

View Slide

}
return
}
let size = CGSize(width: self.view.frame.width,
height: coordinator.contentHeight)
completion(true, parameters, size)
}

View Slide

}
return
}
let size = CGSize(width: self.view.frame.width,
height: coordinator.contentHeight + 15)
completion(true, parameters, size)
}

View Slide

!
CARROT MODE:
LOL CLIPBOARD WORKAROUNDS

View Slide

UX FOR VOICE

View Slide

VoiceX

View Slide

VoiceX
(TOO ELON MUSK)

View Slide

VUX

View Slide

VUX
(SOUNDS TOO MUCH LIKE VOX)

VX

VX
(IS NERVE GAS)

UX FOR VOICE

KEEP SUGGESTED INVOCATION PHRASES
SHORT AND SIMPLE

View Slide

HEY SIRI, WHEN IS MY NEXT FLIGHT?

View Slide

HEY SIRI, WHEN IS MY NEXT FLIGHT?

View Slide

WHEN IS MY NEXT FLIGHT?

View Slide

NEXT FLIGHT

View Slide

OBLIGATORY SUMMARY SLIDE

View Slide

> Shortcuts are a great tool for automation

View Slide

> your shortcuts are a bit more limited

View Slide

> Use NSUserActivity for basic shortcuts

View Slide

> Use Custom Intents for complex shortcuts

View Slide

> Keep titles / invocation phrases short

View Slide

> Custom responses handle errors clearly

View Slide

> Custom responses handle errors clearly
> Responses + Intent UI = users

View Slide

LINKS!
> Siri Shortcuts ebook by Mohammad Azam
https://gumroad.com/l/eHKUm/
SIRIshortcuts
> A Beginner's Guide to developing custom
intent siri shortcuts for iOS 12 by Peter
Minarik
https://medium.com/@pietropizzi/
a-beginners-guide-to-developing-
custom-intent-siri-shortcuts-for-
ios-12-a3627b7011af

View Slide

WWDC VIDEOS!
> Session 211: Introduction to Siri Shortcuts
https://developer.apple.com/
videos/play/wwdc2018/211/
> Session 214: Building for Voice with Siri
Shortcuts

View Slide

MOAR WWDC VIDEOS!
> Session 217: Siri Shortcuts On The Watch Face
> Session 404: New Localization Workflows in
Xcode 10

View Slide

MACSTORIES LINKS!
> Shortcuts: A New Vision for Siri and iOS
Automation
https://www.macstories.net/
stories/shortcuts-a-new-vision-
for-siri-and-ios-automation/
> Original Workflow Review
https://www.macstories.net/
reviews/workflow-review-
integrated-automation-for-ios-8/

View Slide

EXCAVATED LINKS!
> Original Workflow Teaser video
https://www.youtube.com/watch?
v=fSh6Q0F4d9Q

View Slide

Siri Shortcuts - Swift Heroes, Torino, Italy, November 2018

Siri Shortcuts - Swift Heroes, Torino, Italy, November 2018

Ellen Shapiro
PRO

More Decks by Ellen Shapiro

Other Decks in Technology

Featured

Transcript

Siri Shortcuts - Swift Heroes, Torino, Italy, November 2018

Siri Shortcuts - Swift Heroes, Torino, Italy, November 2018

Ellen Shapiro PRO

More Decks by Ellen Shapiro

Other Decks in Technology

Featured

Transcript

Ellen Shapiro
PRO