Implement Application Shortcut in App using swift 4

Application Shortcut

Application shortcut is the way where we can perform some task fast without open the main App & go to particular section . App Shortcut will directly to specified location , but there is some limitation to use this Shortcut it will support to iPhone 6s to above phone .

There is Some Steps to Follow.

1: Open Your App Delegate File .

a: Here I have taken one shortcut that will go to your Cart Controller in App.

declare their unique key : it is unique key to define the App Shortcut that will help to update this name or other value later .

enum AppShortCutKey:String{
    case cartKey = "cartselection"
}

enum AppShortCutKey:String{

case cartKey = "cartselection"

}

b: Go to this Function in App Delegate file and write this:

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

 self.setupAppShortCut(application, launchOptions: launchOptions)
}

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

self.setupAppShortCut(application, launchOptions: launchOptions)

}

c: Now we have to define this method:

    func setupAppShortCut(_ application: UIApplication,launchOptions: [UIApplicationLaunchOptionsKey: Any]?){
        // If a shortcut was launched, display its information and take the appropriate action.
        if let shortcutItem = launchOptions?[UIApplicationLaunchOptionsKey.shortcutItem] as? UIApplicationShortcutItem {
            launchedShortcutItem = shortcutItem
        }
        
        
        if let shortcutItems = application.shortcutItems, shortcutItems.isEmpty {
            
            
            let icon1 = UIApplicationShortcutIcon(templateImageName:"ic_cart")
            let item1 = UIApplicationShortcutItem(type: AppShortCutKey.cartKey.rawValue, localizedTitle: "cart".localized, localizedSubtitle: "startshopping".localized, icon: icon1, userInfo: nil)
            
            
            
            
            UIApplication.shared.shortcutItems = [item2]
            
        }
        
        
        
    }

func setupAppShortCut(_ application: UIApplication,launchOptions: [UIApplicationLaunchOptionsKey: Any]?){

// If a shortcut was launched, display its information and take the appropriate action.

if let shortcutItem = launchOptions?[UIApplicationLaunchOptionsKey.shortcutItem] as? UIApplicationShortcutItem {

launchedShortcutItem = shortcutItem

}

if let shortcutItems = application.shortcutItems, shortcutItems.isEmpty {

let icon1 = UIApplicationShortcutIcon(templateImageName:"ic_cart")

let item1 = UIApplicationShortcutItem(type: AppShortCutKey.cartKey.rawValue, localizedTitle: "cart".localized, localizedSubtitle: "startshopping".localized, icon: icon1, userInfo: nil)

UIApplication.shared.shortcutItems = [item2]

}

Note: Here we are checking the App Shortcut is Created before or not so if is empty than it will create other wise return the previous one.

d: Declare Shortcut Item in Appdelegate.swift class:

class AppDelegate: UIResponder, UIApplicationDelegate {
    
var launchedShortcutItem: UIApplicationShortcutItem?

}

class AppDelegate: UIResponder, UIApplicationDelegate {

var launchedShortcutItem: UIApplicationShortcutItem?

}

2: Handle the Click Event Of App Shortcut.

a: Override this method in App Delegate file:

extension AppDelegate{
    func handleShortCutItem(_ shortcutItem: UIApplicationShortcutItem) -> Bool {
        var handled = false
        
        guard let shortCutType = shortcutItem.type as String? else { return false }
        
       
        
        switch shortCutType {
        case AppShortCutKey.searchKey.rawValue:
            handled = true
            NotificationCenter.default.post(name: NSNotification.Name(rawValue: "shortcutsearchtap"), object: nil, userInfo: nil)
            break
            
        
            
        default:
            break
        }
        
        
        return handled
    }
    
    
    func application(_ application: UIApplication, performActionFor shortcutItem: UIApplicationShortcutItem, completionHandler: @escaping (Bool) -> Void) {
        let handledShortCutItem = handleShortCutItem(shortcutItem)
        completionHandler(handledShortCutItem)
    }
    
}

extension AppDelegate{

func handleShortCutItem(_ shortcutItem: UIApplicationShortcutItem) -> Bool {

var handled = false

guard let shortCutType = shortcutItem.type as String? else { return false }

switch shortCutType {

case AppShortCutKey.searchKey.rawValue:

handled = true

NotificationCenter.default.post(name: NSNotification.Name(rawValue: "shortcutsearchtap"), object: nil, userInfo: nil)

break

default:

break

}

return handled

}

func application(_ application: UIApplication, performActionFor shortcutItem: UIApplicationShortcutItem, completionHandler: @escaping (Bool) -> Void) {

let handledShortCutItem = handleShortCutItem(shortcutItem)

completionHandler(handledShortCutItem)

}

Note: If you click on Any Shortcut item , this method will automatically call so you need to return true for successfully execution.

Here i have taken Local Notification to handle the request.

You have to define this “shortcutsearchtap” in your start viewcontroller in ViewDidload Method.

In Our Case i have start viewcontroller is ViewController.swift class.

class ViewController: UIViewController,UISearchBarDelegate,CategoryViewControllerHandlerDelegate,BrandViewControllerHandlerDelegate,productViewControllerHandlerDelegate,bannerViewControllerHandlerDelegate,UITabBarControllerDelegate, RecentProductViewControllerHandlerDelegate{
    
 
    
    
    override func viewDidLoad() {
        super.viewDidLoad()
        NotificationCenter.default.addObserver(self, selector: #selector(self.goToCart), name: NSNotification.Name(rawValue: "shortcutcarttap"), object: nil)

     }


 func goToCart(_ note: Notification) {
        self.tabBarController?.selectedIndex = 3
       // handle this request
    }


}

class ViewController: UIViewController,UISearchBarDelegate,CategoryViewControllerHandlerDelegate,BrandViewControllerHandlerDelegate,productViewControllerHandlerDelegate,bannerViewControllerHandlerDelegate,UITabBarControllerDelegate, RecentProductViewControllerHandlerDelegate{

override func viewDidLoad() {

super.viewDidLoad()

NotificationCenter.default.addObserver(self, selector: #selector(self.goToCart), name: NSNotification.Name(rawValue: "shortcutcarttap"), object: nil)

}

func goToCart(_ note: Notification) {

self.tabBarController?.selectedIndex = 3

// handle this request

}

if you have any suggestion or issues feel free to ask . in next update of Blog , we will introduce how to update the Application shortcut & Add new One on run time as well as how to handle when the Application is kill.

kunal prasad 25 October 2021

. . .

Implement Application Shortcut in App using swift 4

Application Shortcut

if you have any suggestion or issues feel free to ask . in next update of Blog , we will introduce how to update the Application shortcut & Add new One on run time as well as how to handle when the Application is kill.

Leave a Comment Cancel Reply

Message Sent!