Merge pull request #7298 from hansemannn/TIMOB-19708-5_1_X

[TIMOB-19708, TIMOB-19709, TIMOB-19710, TIMOB-19711, TIMOB-19712, TIMOB-19713, TIMOB-19714, TIMOB-19715](5_1_X) Fix and improve UIApplicationShortcuts
tidev · Oct 14, 2015 · 9dc18de · 9dc18de
2 parents 1076438 + 742eb43
commit 9dc18de
Show file tree

Hide file tree

Showing 6 changed files with 222 additions and 102 deletions.
diff --git a/apidoc/Titanium/App/iOS/iOS.yml b/apidoc/Titanium/App/iOS/iOS.yml
@@ -1012,7 +1012,7 @@ events:
   - name: shortcutitemclick
     summary: Fired when a user taps the Application Shortcut.
     properties:
-      - name: type
+      - name: itemtype
         summary: The unique identifier for the application shortcut.
         type: String
 
@@ -1025,7 +1025,7 @@ events:
         type: String
 
       - name: userInfo
-        summary: The payload passed by the Application Shortcut.
+        summary: The payload passed by the application shortcut.
         type: Dictionary        
     platforms: [iphone]
     osver: {ios: {min: "9.0"}}

diff --git a/apidoc/Titanium/UI/iOS/ApplicationShortcuts.yml b/apidoc/Titanium/UI/iOS/ApplicationShortcuts.yml
@@ -6,7 +6,8 @@ description: |
     app-specific actions from the Home screen by pressing on the app icon. The pressing of an application shortcut
     will then fire the `shortcutitemclick` Titanium.App.iOS event.
 
-    To use this feature make sure you have a 3D Touch compatible device running iOS 9 or later.
+    To use this feature make sure you have a 3D Touch compatible device running iOS 9 or later. You can check
+    this by using the <Titanium.UI.iOS.forceTouchSupported> property.
 extends: Titanium.Proxy
 platforms: [iphone]
 osver: {ios: {min: "9.0"}}
@@ -30,112 +31,162 @@ methods:
   - name: dynamicShortcutExists
     summary: Returns true or false depending if the provided shortcut dictionary already exists.
     parameters:
-      - name: params
-        summary: |
-            The parameters used when creating the dynamic shortcut.  Must include a `type` property, 
-            to determine if the shortcut exists.
-        type: Dictionary
+      - name: itemtype
+        summary: Checks if the dynamic application shortcut item identified by the `itemtype` exists.
+        type: String
     returns:
         type: Boolean        
 
-  - name: addShortcutItem
-    summary: Creates a dynamic application shortcut.
+  - name: addDynamicShortcut
+    summary: Creates a new dynamic application shortcut item.
     parameters:
       - name: params
+        summary: The parameters used when creating a dynamic shortcut.
+        type: ShortcutParams
+
+  - name: removeDynamicShortcut
+    summary: Removes the dynamic application shortcut item identified by the `itemtype`.
+    parameters:
+      - name: itemtype
         summary: |
-            The parameters used when creating the dynamic shortcut.  Must include the `type` and `title` properties.
-            Properties are:
-            	* type - the unique key for the application shortcut
-            	* title - the title of the application shortcut
-            	* subtitle - the subtitle displayed on the application shortcut
-            	* icon - the icon to be displayed on the application shortcut, for example Titanium.UI.iOS.SHORTCUT_ICON_TYPE_COMPOSE
-        type: Dictionary
-
-  - name: removeShortcutItem
-    summary: Removes the provided application shortcut item.
+            Use the `itemtype` property to determine which shortcut should be removed.
+        type: String
+
+  - name: getDynamicShortcut
+    summary: Gets the dynamic application shortcut item identified by the `itemtype`.
+
     parameters:
-      - name: params
+      - name: itemtype
         summary: |
-            The parameters used when creating the dynamic shortcut.  Must include a `type` property, 
-            to determine which shortcut should be removed.
-        type: Dictionary
+            Use the `itemtype` property to determine which shortcut should be returned.
+        type: String
 
-examples: 
+examples:
   - title: Example app.js
     example: |
         The following code excerpt demonstrates
 
-            var win = Titanium.UI.createWindow({  
-                title:'Example', backgroundColor:'#fff', layout:"vertical"
+            Ti.App.iOS.addEventListener("shortcutitemclick", function(e){
+                Ti.API.info("shortcutitemclick Event Fired");
+                Ti.API.info("event payload:" + JSON.stringify(e));
+            });
+
+            var win = Titanium.UI.createWindow({
+                title:'Test', backgroundColor:'#fff', layout:"vertical"
             });
 
             var btn1 = Ti.UI.createButton({
-            	top: 50, height:45, title:"Add Contact Us Application Shortcut"
+                top: 50, height:45, title:"Add Contact Us Application Shortcut"
             });
             win.add(btn1);
 
             btn1.addEventListener("click",function(){
-            	var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
-            	appShortcuts.addShortcutItem({
-            		type:"contact_us",
-            		title:"Contact Us",
-            		subtitle:"Tap to reach us",
-            		icon: Ti.UI.iOS.SHORTCUT_ICON_TYPE_ADD,
-            		userInfo:{
-            			infoKey:"contact_us"
-            		}
-            	});
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                appShortcuts.addDynamicShortcut({
+                    itemtype:"contact_us",
+                    title:"Contact Us",
+                    subtitle:"Tap to reach us",
+                    icon: Ti.UI.iOS.SHORTCUT_ICON_TYPE_ADD,
+                    userInfo:{
+                        infoKey:"contact_us"
+                    }
+                });
             });
 
             var btn2 = Ti.UI.createButton({
-            	top: 10, height:45, title:"Remove Contact Us Application Shortcut"
+                top: 10, height:45, title:"Remove Contact Us Application Shortcut"
             });
             win.add(btn2);
+
             btn2.addEventListener("click",function(){
-            	var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
-            	appShortcuts.removeShortcutItem({
-            		type:"contact_us"
-            	});	
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                appShortcuts.removeDynamicShortcut("contact_us");
             });
 
             var btn3 = Ti.UI.createButton({
-            	top: 10, height:45, title:"Count Dynamic App Shortcuts"
+                top: 10, height:45, title:"Count Dynamic App Shortcuts"
             });
             win.add(btn3);
+
             btn3.addEventListener("click",function(){
-            	var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
-            	var shortcutItems = appShortcuts.listDynamicShortcuts();
-            	Ti.API.info("Dynamic App Shortcut as JSON:" + JSON.stringify(shortcutItems));	
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                var shortcuts = appShortcuts.listDynamicShortcuts();
+                Ti.API.info("Dynamic App Shortcut count:" + shortcuts.length);
+                Ti.API.info("Dynamic App Shortcut as JSON:" + JSON.stringify(shortcuts));
             });
 
             var btn4 = Ti.UI.createButton({
-            	top: 10, height:45, title:"Count Static App Shortcuts"
+                top: 10, height:45, title:"Count Static App Shortcuts"
             });
             win.add(btn4);
+
             btn4.addEventListener("click",function(){
-            	var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
-            	var shortcutItems = appShortcuts.listStaticShortcuts();
-            	Ti.API.info("Static App Shortcut as JSON:" + JSON.stringify(shortcutItems));
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                var shortcuts = appShortcuts.listStaticShortcuts();
+                Ti.API.info("Static App Shortcut count:" + shortcuts.length);
+                Ti.API.info("Static App Shortcut as JSON:" + JSON.stringify(shortcuts));
             });
 
             var btn5 = Ti.UI.createButton({
-            	top: 10, height:45, title:"Dynamic Shortcut Exists?"
+                top: 10, height:45, title:"Dynamic Shortcut Exists?"
             });
             win.add(btn5);
+
             btn5.addEventListener("click",function(){
-            	var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
-            	var exists = appShortcuts.dynamicShortcutExists({
-            		type:"contact_us"
-            	});		
-            	var msg = (exists) ? "Icon exists" : "Sorry isn't there";
-            	alert(msg);
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                var exists = appShortcuts.dynamicShortcutExists("contact_us");
+                var msg = (exists) ? "Icon exists" : "Sorry isn't there";
+                alert(msg);
             });
 
             var btn6 = Ti.UI.createButton({
-            	top: 10, height:45, title:"Remove All Dynamic Shortcuts"
+                top: 10, height:45, title:"Remove All Dynamic Shortcuts"
             });
             win.add(btn6);
+
             btn6.addEventListener("click",function(){
-            	var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
-            	appShortcuts.removeAllDynamicShortcuts();
-            });
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                appShortcuts.removeAllDynamicShortcuts();
+            });
+
+            var btn7 = Ti.UI.createButton({
+                top: 10, height:45, title:"Get shortcut by itemtype \"contact_us\""
+            });
+            win.add(btn7);
+
+            btn7.addEventListener("click",function(){
+                var appShortcuts = Ti.UI.iOS.createApplicationShortcuts();
+                var shortcut = appShortcuts.getDynamicShortcut("contact_us");
+                alert(shortcut);
+            });
+
+            win.open();
+
+---
+name: ShortcutParams
+summary: Dictionary of options for <Titanium.UI.iOS.addDynamicShortcut>.
+description: |
+    The parameters used when creating the dynamic shortcut.  Must include the `itemtype` and `title` properties.
+properties:
+  - name: itemtype
+    summary: The unique key for the application shortcut.
+    type: String
+    optional: false
+
+  - name: title
+    summary: The title of the application shortcut
+    type: String
+    optional: false
+
+  - name: subtitle
+    summary: The subtitle displayed on the application shortcut
+    type: String
+    optional: true
+
+  - name: icon
+    summary: |
+        The icon to be displayed on the application shortcut, for example <Titanium.UI.iOS.SHORTCUT_ICON_TYPE_COMPOSE>.
+        Note: You can also use a local image specified by the image path.
+    type: Number
+    constants: Titanium.UI.iOS.SHORTCUT_ICON_TYPE_*
+    optional: true
diff --git a/iphone/Classes/TiApp.m b/iphone/Classes/TiApp.m
@@ -413,10 +413,12 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 	}
 
 #if IS_XCODE_7
-    UIApplicationShortcutItem *shortcut = [launchOptions objectForKey:UIApplicationLaunchOptionsShortcutItemKey];
-
-    if(shortcut !=nil) {
-        launchedShortcutItem = shortcut;
+    if ([TiUtils isIOS9OrGreater] == YES) {
+        UIApplicationShortcutItem *shortcut = [launchOptions objectForKey:UIApplicationLaunchOptionsShortcutItemKey];
+
+        if (shortcut != nil) {
+            launchedShortcutItem = shortcut;
+        }
     }
 #endif
 

diff --git a/iphone/Classes/TiAppiOSProxy.m b/iphone/Classes/TiAppiOSProxy.m
@@ -167,7 +167,14 @@ -(void)_listenerRemoved:(NSString*)type count:(int)count
 
 -(void)didReceiveApplicationShortcutNotification:(NSNotification*)info
 {
-    [self fireEvent:@"shortcutitemclick" withObject:[info userInfo]];
+    NSDictionary *event = @{
+        @"title" : [[info userInfo] valueForKey:@"title"],
+        @"subtitle" : [[info userInfo] valueForKey:@"subtitle"],
+        @"itemtype" : [[info userInfo] valueForKey:@"type"],
+        @"userInfo" : [[info userInfo] objectForKey:@"userInfo"],
+    };
+
+    [self fireEvent:@"shortcutitemclick" withObject:event];
 }
 
 -(id)createSearchableIndex:(id)unused

diff --git a/iphone/Classes/TiBase.m b/iphone/Classes/TiBase.m
@@ -164,7 +164,7 @@ void TiLogMessage(NSString* str, ...) {
 NSString * const kTiUserNotificationSettingsNotification = @"TiUserNotificationSettingsNotification";
 NSString * const kTiWatchKitExtensionRequest = @"TiWatchKitExtensionRequest";
 NSString * const kTiContinueActivity = @"TiContinueActivity";
-NSString * const kTiApplicationShortcut = @"kTiContinueActivity";
+NSString * const kTiApplicationShortcut = @"TiApplicationShortcut";
 
 #ifndef TI_USE_AUTOLAYOUT
 NSString* const kTiBehaviorSize = @"SIZE";