Launching with UIApplicationShortcutItem

Question

I'm implementing some 3D touch quick actions for my iOS 9 app in swift, and I have a curious issue. When my app is in the background and I launch with the quick action, everything goes as planned. When my app is totally dead (i.e. I killed it from the multitasking menu), and I launch with the quick action, the app crashes. I'm having trouble debugging this as once I kill the app, the debug session in Xcode gets detached. Is there a way for me to connect to the app to debug like normal, or is there something in my code that would be causing it? Thanks in advance.

Code:

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool
{
    var launchedFromShortCut = false

    //Check for ShortCutItem
    if let shortcutItem = launchOptions?[UIApplicationLaunchOptionsShortcutItemKey] as? UIApplicationShortcutItem
    {
        launchedFromShortCut = true
        self.handleShortCutItem(shortcutItem)
    }

    return !launchedFromShortCut
}

func application(application: UIApplication, performActionForShortcutItem shortcutItem: UIApplicationShortcutItem, completionHandler: (Bool) -> Void)
{
    self.handleShortCutItem(shortcutItem)
}

func handleShortCutItem(shortcutItem: UIApplicationShortcutItem)
{
    //Get type string from shortcutItem
    if let shortcutType = ShortcutType.init(rawValue: shortcutItem.type)
    {
        //Get root navigation viewcontroller and its first controller
        let rootNavigationViewController = window!.rootViewController as? UINavigationController


        if let rootViewController = rootNavigationViewController?.viewControllers.first as! LaunchViewController?
        {
            //Pop to root view controller so that approperiete segue can be performed
            rootNavigationViewController?.popToRootViewControllerAnimated(false)

            switch shortcutType
            {
                case .Compose:
                    rootViewController.shouldCompose()
                    break
            }
        }
    }
}

Thanks!

You can still look at the app's crash log file after it is killed... — George Asda, Sep 27 '15 at 08:42
I think this post can answer your questions. hope that helps. http://stackoverflow.com/questions/32634024/3d-touch-home-shortcuts-in-obj-c/32772446#32772446 — imcc, Oct 07 '15 at 01:50
Same issue here. I've tried all the same code as your example above, but run into the same issue when running from a killed state. The below suggestion does not seem to catch the output when launching from the shortcut. — ZbadhabitZ, Oct 19 '15 at 20:15

score 63 · Answer 1 · edited Sep 25 '20 at 06:31

63

In Xcode, open Product -> Schemes -> Edit Schemes
In your Run Scheme, change the Launch setting to 'Wait for executable to be launched'

Now, if you turn on debugging and run your app, Xcode will wait for you to launch your app from the home screen so you are able to test launching it using a 3D Touch Shortcut Item.

edited Sep 25 '20 at 06:31

Rakesha Shastri

11,053
3
37
50

answered Oct 12 '15 at 21:55

Andrew Varvel

1,286
1
10
19

1

Thank you so much! This allowed me to test quick action from a terminated state. +1 – anon_nerd Oct 31 '15 at 07:14
2

How do I get to print things to the console? – romero-ios Sep 01 '16 at 16:38
Helal olsun amk. ADAMSIN! – Ozgur Vatansever Dec 18 '17 at 11:57
This is super useful! Just make sure to run (cmd+R) in Xcode first, then start the App. – Marcel Zanoni Jan 03 '19 at 10:08

score 27 · Accepted Answer · answered Oct 22 '15 at 14:11

I finally got this working. Here's what my AppDelegate.swift file ended up as;

class AppDelegate: UIResponder, UIApplicationDelegate {

// Properties
var window: UIWindow?
var launchedShortcutItem: UIApplicationShortcutItem?

func applicationDidBecomeActive(application: UIApplication) {

    guard let shortcut = launchedShortcutItem else { return }

    handleShortcut(shortcut)

    launchedShortcutItem = nil

}

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {

    // Override point for customization after application launch.
    var shouldPerformAdditionalDelegateHandling = true

    // If a shortcut was launched, display its information and take the appropriate action
    if let shortcutItem = launchOptions?[UIApplicationLaunchOptionsShortcutItemKey] as? UIApplicationShortcutItem {

        launchedShortcutItem = shortcutItem

        // This will block "performActionForShortcutItem:completionHandler" from being called.
        shouldPerformAdditionalDelegateHandling = false

    }

    return shouldPerformAdditionalDelegateHandling
}


func handleShortcut( shortcutItem:UIApplicationShortcutItem ) -> Bool {

    // Construct an alert using the details of the shortcut used to open the application.
    let alertController = UIAlertController(title: "Shortcut Handled", message: "\"\(shortcutItem.localizedTitle)\"", preferredStyle: .Alert)
    let okAction = UIAlertAction(title: "OK", style: .Default, handler: nil)
    alertController.addAction(okAction)

    // Display an alert indicating the shortcut selected from the home screen.
    window!.rootViewController?.presentViewController(alertController, animated: true, completion: nil)

    return handled

}

func application(application: UIApplication, performActionForShortcutItem shortcutItem: UIApplicationShortcutItem, completionHandler: (Bool) -> Void) {

    completionHandler(handleShortcut(shortcutItem))

}

Much of this was taken from Apple's sample code for UIApplicationShortcuts, and while I'm having my app launch an alert to prove that it is recognizing the proper shortcut was chosen, this could be adapted to your code to pop the view controller.

I think the func applicationDidBecomeActive was the critical part that I was missing, and removing the self.handleShortCut(shortcutItem) from didFinishLaunchingWithOptions (otherwise it was calling handleShortCut twice, it seemed).

From Apple example, func handleShortcut always return true, so probably "handled" is true — zdravko zdravkin, May 09 '22 at 10:29

Atul Pol · Answer 3 · 2019-02-05T13:17:15.113

3

For Swift 4.2

   func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // Override point for customization after application launch.
    var isLaunchedFromQuickAction = false
    if let shortcutItem = launchOptions?[UIApplication.LaunchOptionsKey.shortcutItem] as? UIApplicationShortcutItem {
        isLaunchedFromQuickAction = true
        handleQuickAction(shortcutItem: shortcutItem)
    }

    return isLaunchedFromQuickAction
}

edited Feb 05 '19 at 13:17

answered Feb 05 '19 at 13:11

Atul Pol

341
3
5

@OmarNShamali Wc :-) – Atul Pol Jul 13 '19 at 13:06
I know this is an old post but do you have any idea why ``launchOptions?[UIApplication.LaunchOptionsKey.shortcutItem] as? UIApplicationShortcutItem`` is evaluating to nil even when the app is called by a quickaction? – fisch Dec 04 '20 at 05:08

score 1 · Answer 4 · answered Dec 22 '15 at 16:59

I tried all the above, and it didn't solve the problem than I tried handling the shortcut after delay in handleShortcut method:

self.performSelector("action1", withObject: self, afterDelay: 0.5)

and added a method for every action, and it worked like a charm

score 1 · Answer 5 · edited Feb 05 '18 at 11:36

1

Replace your didfinishlaunching method with this one.

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject : AnyObject]?) -> Bool {

  if let shortcutItem =
       launchOptions?[UIApplicationLaunchOptionsShortcutItemKey]
       as? UIApplicationShortcutItem {

    handleShortcut(shortcutItem)
    return false
  }
  return true
}

edited Feb 05 '18 at 11:36

Eric Aya

69,473
35
181
253

answered Feb 05 '18 at 11:26

Vishal Seth

11
2

Pratik · Answer 6 · 2021-01-06T12:36:30.817

XCode 11.6, Swift 5

We can attach a process at runtime. XCode will wait until the process is started and will get attached to it when an App is launched manually.

XCode -> Debug -> Attach to process by PID or Name -> ("Enter the name of an app in the pop-up")

Directions:

Make sure an application is freshly installed on a device or a simulator.
Kill the application.
In XCode attach the name of the process as mentioned above.
Open the application through the desired shortcut

P.S: If you are using SceneDelegate a shortcutItem can be found in

func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
       switch connectionOptions.shortcutItem?.localizedTitle {
       case "Search":
       break
       case "DoSomething":
       break
       default:
       break
       } 
    }

Happy Debugging :)

Launching with UIApplicationShortcutItem

6 Answers6

Linked