[TIMOB-26312]: iOS 12 Expose new NSUserActivity APIs for Siri Intents

apidoc/Titanium/App/iOS/UserActivity.yml

@@ -69,6 +69,29 @@ properties:
     default: true
     availability: creation
 
+  - name: eligibleForPrediction
+    summary: |
+        A Boolean value that determines whether Siri can suggest the user activity as a shortcut to the user.
+    description: |
+        To donate a user activity to Siri Shortcuts, set eligibleForPrediction to 'true' and make the 
+        user activity current. To make the user activity current, call the becomeCurrent method of activity.
+        For more information, see https://developer.apple.com/documentation/sirikit/donating_shortcuts?language=objc.    
+    type: Boolean
+    osver: {ios: {min: "12.0"}}
+    default: false
+    since: "7.4.0"
+    availability: creation
+
+  - name: persistentIdentifier
+    summary: A value used to identify the user activity.
+    description: |
+        Set this property to a unique value that identifies the user activity so you can later delete it with 
+        Ti.App.iOS.UserActivity.deleteSavedUserActivitiesForPersistentIdentifiers method.
+    type: String
+    osver: {ios: {min: "12.0"}}
+    since: "7.4.0"
+    availability: creation
+
   - name: expirationDate
     summary: Absolute date after which the activity is no longer eligible to be indexed or handed off.
     description: |
@@ -159,6 +182,33 @@ methods:
         summary: Returns `true` if the device supports user activity.
     platforms: [iphone, ipad]
     osver: {ios: {min: "8.0"}}
+
+  - name: deleteSavedUserActivitiesForPersistentIdentifiers
+    summary: |
+        Deletes user activities created by your app that have the specified persistent identifiers.
+    description: |
+        Ti.App.iOS.UserActivity.useractivitydeleted event get fired after deteting the user activities. 
+        Listen and wait for this event to fired to ensure that the system deletes the activities 
+        (or marks them for deletion).
+    parameters:
+      - name: persistentIdentifiers
+        summary: Array of persistent identifiers of user activity.
+        type: Array<String>
+    platforms: [iphone, ipad]
+    osver: {ios: {min: "12.0"}}
+    since: "7.4.0"
+
+  - name: deleteAllSavedUserActivities
+    summary: |
+        Deletes all user activities created by your app.
+    description: |
+        Ti.App.iOS.UserActivity.useractivitydeleted event get fired after deteting the user activities. 
+        Listen and wait for this event to fired to ensure that the system deletes the activities 
+        (or marks them for deletion).
+    platforms: [iphone, ipad]
+    osver: {ios: {min: "12.0"}}
+    since: "7.4.0"
+
 events:
   - name: useractivitywillsave
     summary: |
@@ -216,6 +266,15 @@ events:
         summary: Dictionary object containing the userInfo data of the User Activity.
         type: Dictionary
         platforms: [iphone, ipad]
+
+  - name: useractivitydeleted
+    summary: |
+        Fired when the user activity get deleted using Ti.App.iOS.UserActivity.deleteAllSavedUserActivities or 
+        Ti.App.iOS.UserActivity.deleteSavedUserActivitiesForPersistentIdentifiers method.
+    platforms: [iphone, ipad]
+    osver: {ios: {min: "12.0"}}
+    since: "7.4.0"
+
 examples:
   - title: Creating a new UserActivity Example
     example: |

iphone/Classes/TiAppiOSUserActivityProxy.m

@@ -123,6 +123,19 @@ - (void)buildInitialActivity:(NSDictionary *)props
     }
   }
 
+#if IS_XCODE_10
+  if ([TiUtils isIOSVersionOrGreater:@"12.0"]) {
+    if ([props objectForKey:@"eligibleForPrediction"]) {
+      [_userActivity setEligibleForPrediction:[TiUtils boolValue:@"eligibleForPrediction" properties:props]];
+    }
+
+    if ([props objectForKey:@"persistentIdentifier"]) {
+      [_userActivity setPersistentIdentifier:[TiUtils stringValue:@"persistentIdentifier"
+                                                       properties:props]];
+    }
+  }
+#endif
+
   _userActivity.delegate = self;
 }
 
@@ -425,6 +438,73 @@ - (void)resignCurrent:(id)unused
   }
   [_userActivity resignCurrent];
 }
+
+#if IS_XCODE_10
+
+- (NSNumber *)eligibleForPrediction
+{
+  if (![TiUtils isIOSVersionLower:@"12.0"]) {
+    return NUMBOOL(NO);
+  }
+
+  return NUMBOOL(_userActivity.isEligibleForPrediction);
+}
+
+- (void)setEligibleForPrediction:(NSNumber *)value
+{
+  ENSURE_TYPE(value, NSNumber);
+  ENSURE_UI_THREAD(setEligibleForSearch, value);
+  if (![TiUtils isIOSVersionLower:@"12.0"]) {
+    return;
+  }
+  [_userActivity setEligibleForPrediction:[TiUtils boolValue:value]];
+}
+
+- (NSString *)persistentIdentifier
+{
+  if (![TiUtils isIOSVersionLower:@"12.0"]) {
+    return nil;
+  }
+
+  return _userActivity.persistentIdentifier;
+}
+
+- (void)setPersistentIdentifier:(NSString *)value
+{
+  ENSURE_TYPE(value, NSString);
+  if ([TiUtils isIOSVersionLower:@"12.0"]) {
+    return;
+  }
+  [_userActivity setPersistentIdentifier:[TiUtils stringValue:value]];
+}
+
+- (void)deleteSavedUserActivitiesForPersistentIdentifiers:(id)persistentIdentifiers
+{
+  ENSURE_ARRAY(persistentIdentifiers);
+  if ([TiUtils isIOSVersionLower:@"12.0"]) {
+    return;
+  }
+  [NSUserActivity deleteSavedUserActivitiesWithPersistentIdentifiers:persistentIdentifiers
+                                                   completionHandler:^{
+                                                     if ([self _hasListeners:@"useractivitydeleted"]) {
+                                                       [self fireEvent:@"useractivitydeleted" withObject:nil];
+                                                     }
+                                                   }];
+}
+
+- (void)deleteAllSavedUserActivities:(id)unused
+{
+  if ([TiUtils isIOSVersionLower:@"12.0"]) {
+    return;
+  }
+  [NSUserActivity deleteAllSavedUserActivitiesWithCompletionHandler:^{
+    if ([self _hasListeners:@"useractivitydeleted"]) {
+      [self fireEvent:@"useractivitydeleted" withObject:nil];
+    }
+  }];
+}
+
+#endif
 @end
 
 #endif