[TIMOB-26294] TiAPI: Notify app about user-interactions

android/titanium/src/java/org/appcelerator/titanium/TiBaseActivity.java

@@ -1493,12 +1493,10 @@ protected void onRestart()
 	 * When a key, touch, or trackball event is dispatched to the activity, this method fires the
 	 * javascript 'userinteraction' event.
 	 */
-	public void onUserInteraction()
+	protected void onUserInteraction()
 	{
-		Log.d(TAG, "Activity " + this + " onUserInteraction", Log.DEBUG_MODE);
-
-		if (activityProxy != null) {
-			activityProxy.fireEvent(TiC.EVENT_USER_INTERACTION, null);
+		if (TiApplication.hasListeners(TiC.EVENT_USER_INTERACTION)) {
+			TiApplication.getInstance().fireAppEvent(TiC.EVENT_USER_INTERACTION, null);
 		}
 
 		super.onUserInteraction();

apidoc/Titanium/App/App.yml

@@ -331,6 +331,22 @@ events:
     platforms: [iphone, ipad]
     since: '3.1.0'
 
+  - name: userinteraction
+    summary: Called whenever an interaction with the window occurred. To be used together with the <Titanium.App.trackUserInteraction> property.
+    description: |
+        Implement this method if you wish to know that the user has interacted with the device in some 
+        way while your app is running.
+
+        Note that this callback will be invoked for the touch down action that begins a touch gesture, 
+        but may not be invoked for the touch-moved and touch-up actions that follow.
+
+        See also:
+          - Android: See the [onUserInteraction](https://developer.android.com/reference/android/app/Activity.html#onUserInteraction()) callback
+          - iOS: See the [sendEvent](https://developer.apple.com/documentation/uikit/uiapplication/1623043-sendevent) delegate
+
+    platforms: [android, iphone, ipad]
+    since: "7.4.0"
+
 methods:
   - name: fireSystemEvent
     summary: Fire a system-level event such as <Titanium.App.EVENT_ACCESSIBILITY_ANNOUNCEMENT>.
@@ -520,6 +536,16 @@ properties:
     permission: read-only
     platforms: [iphone, ipad]
 
+  - name: trackUserInteraction
+    summary: Indicates whether or not the user interaction shoud be tracked.
+    description: |
+        Use the <Titanium.App.userinteraction> event to get notified about user interaction.
+        For Android, user-interactions are controlled by the event and do not require this
+        property to be set explicitely. For iOS, this is done to prevent additional overhead.
+    type: Boolean
+    accessors: false
+    platforms: [iphone, ipad]
+
 ---
 name: launchOptions
 summary: |

iphone/Classes/AppModule.m

@@ -103,6 +103,10 @@ - (void)_configure
                                            selector:@selector(accessibilityVoiceOverStatusChanged:)
                                                name:UIAccessibilityVoiceOverStatusChanged
                                              object:nil];
+  [[NSNotificationCenter defaultCenter] addObserver:self
+                                           selector:@selector(handleUserInteraction:)
+                                               name:kTiUserInteraction
+                                             object:nil];
 }
 
 - (NSString *)apiName
@@ -278,6 +282,13 @@ - (NSNumber *)disableNetworkActivityIndicator
   return NUMBOOL([TiApp app].disableNetworkActivityIndicator);
 }
 
+- (void)handleUserInteraction:(id)notification
+{
+  if ([self _hasListeners:@"userinteraction"]) {
+    [self fireEvent:@"userinteraction" withObject:nil];
+  }
+}
+
 //To fire the keyboard frame change event.
 - (void)keyboardFrameChanged:(NSNotification *)notification
 {

iphone/Classes/TiBase.h

@@ -583,6 +583,7 @@ extern NSString *const kTiBackgroundFetchNotification;
 extern NSString *const kTiSilentPushNotification;
 extern NSString *const kTiBackgroundTransfer;
 extern NSString *const kTiCurrentLocale;
+extern NSString *const kTiUserInteraction;
 extern NSString *const kTiFrameAdjustNotification;
 extern NSString *const kTiLocalNotification;
 extern NSString *const kTiLocalNotificationAction;

iphone/Classes/TiBase.m

@@ -112,6 +112,7 @@ void TiLogMessage(NSString *str, ...)
 NSString *const kTiSilentPushNotification = @"TiSilentPush";
 NSString *const kTiBackgroundTransfer = @"TiBackgroundTransfer";
 NSString *const kTiCurrentLocale = @"kTiCurrentLocale";
+NSString *const kTiUserInteraction = @"kTiUserInteraction";
 NSString *const kTiURLDownloadFinished = @"TiDownloadFinished";
 NSString *const kTiURLSessionCompleted = @"TiSessionCompleted";
 NSString *const kTiURLSessionEventsCompleted = @"TiSessionEventsCompleted";

iphone/Classes/TiUIApplication.h

@@ -0,0 +1,16 @@
+/**
+ * Appcelerator Titanium Mobile
+ * Copyright (c) 2018-present by Appcelerator, Inc. All Rights Reserved.
+ * Licensed under the terms of the Apache Public License
+ * Please see the LICENSE included with this distribution for details.
+ */
+
+#import <UIKit/UIKit.h>
+
+@interface TiUIApplication : UIApplication
+
+#ifdef USE_TI_APPTRACKUSERINTERACTION
+- (void)sendEvent:(UIEvent *)event;
+#endif
+
+@end

iphone/Classes/TiUIApplication.m

@@ -0,0 +1,26 @@
+/**
+ * Appcelerator Titanium Mobile
+ * Copyright (c) 2018-present by Appcelerator, Inc. All Rights Reserved.
+ * Licensed under the terms of the Apache Public License
+ * Please see the LICENSE included with this distribution for details.
+ */
+
+#import "TiUIApplication.h"
+#import "TiBase.h"
+
+@implementation TiUIApplication
+
+#ifdef USE_TI_APPTRACKUSERINTERACTION
+- (void)sendEvent:(UIEvent *)event
+{
+  [super sendEvent:event];
+
+  for (UITouch *touch in event.allTouches) {
+    if (touch.phase == UITouchPhaseBegan) {
+      [[NSNotificationCenter defaultCenter] postNotificationName:kTiUserInteraction object:nil];
+    }
+  }
+}
+#endif
+
+@end

iphone/Classes/defines.h

@@ -15,6 +15,7 @@
 #define USE_TI_ACCELEROMETER
 #define USE_TI_API
 #define USE_TI_APP
+#define USE_TI_APPTRACKUSERINTERACTION
 #define USE_TI_CALENDAR
 #define USE_TI_CONTACTS
 #define USE_TI_DATABASE

iphone/iphone/Titanium.xcodeproj/project.pbxproj

@@ -235,6 +235,7 @@
 		502A68E616EEAA7500661EF6 /* TiUIListViewProxy.m in Sources */ = {isa = PBXBuildFile; fileRef = 502A68D916EEAA7500661EF6 /* TiUIListViewProxy.m */; };
 		502A68EB16F0428500661EF6 /* TiViewTemplate.m in Sources */ = {isa = PBXBuildFile; fileRef = 502A68EA16F0428500661EF6 /* TiViewTemplate.m */; };
 		5081CEF815F8100E00C881D8 /* TiExceptionHandler.m in Sources */ = {isa = PBXBuildFile; fileRef = 5081CEF715F8100E00C881D8 /* TiExceptionHandler.m */; };
+		673144D6211DBAD7001BDBF2 /* TiUIApplication.m in Sources */ = {isa = PBXBuildFile; fileRef = 673144D5211DBAD7001BDBF2 /* TiUIApplication.m */; };
 		823CC8AC1B7F0E4D00D220C7 /* WatchSessionModule.m in Sources */ = {isa = PBXBuildFile; fileRef = 823CC8AB1B7F0E4D00D220C7 /* WatchSessionModule.m */; };
 		838159E21B7A9632002EE811 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 838159EC1B7C3EFA002EE811 /* Assets.xcassets */; };
 		838267951D9DAD6800F99248 /* TiLogServer.m in Sources */ = {isa = PBXBuildFile; fileRef = 838267941D9DAD6800F99248 /* TiLogServer.m */; };
@@ -776,6 +777,8 @@
 		502A68EA16F0428500661EF6 /* TiViewTemplate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TiViewTemplate.m; sourceTree = "<group>"; };
 		5081CEF615F8100E00C881D8 /* TiExceptionHandler.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TiExceptionHandler.h; sourceTree = "<group>"; };
 		5081CEF715F8100E00C881D8 /* TiExceptionHandler.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = TiExceptionHandler.m; sourceTree = "<group>"; };
+		673144D4211DBAD7001BDBF2 /* TiUIApplication.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = TiUIApplication.h; path = ../Classes/TiUIApplication.h; sourceTree = "<group>"; };
+		673144D5211DBAD7001BDBF2 /* TiUIApplication.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = TiUIApplication.m; path = ../Classes/TiUIApplication.m; sourceTree = "<group>"; };
 		823CC8AA1B7F0E4D00D220C7 /* WatchSessionModule.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = WatchSessionModule.h; sourceTree = "<group>"; };
 		823CC8AB1B7F0E4D00D220C7 /* WatchSessionModule.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = WatchSessionModule.m; sourceTree = "<group>"; };
 		838159EC1B7C3EFA002EE811 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
@@ -2002,6 +2005,8 @@
 		29B97315FDCFA39411CA2CEA /* Other Sources */ = {
 			isa = PBXGroup;
 			children = (
+				673144D4211DBAD7001BDBF2 /* TiUIApplication.h */,
+				673144D5211DBAD7001BDBF2 /* TiUIApplication.m */,
 				32CA4F630368D1EE00C91783 /* Titanium_Prefix.pch */,
 				29B97316FDCFA39411CA2CEA /* main.m */,
 				241EAA21118AB3BB0081A5BE /* defines.h */,
@@ -2587,6 +2592,7 @@
 				159C599B1C383645009A8860 /* TiUIiOSTableViewCellSelectionStyleProxy.m in Sources */,
 				24CA8B95111161FE0084E2DE /* TiUIProgressBarProxy.m in Sources */,
 				24CA8B96111161FE0084E2DE /* TiUIProgressBar.m in Sources */,
+				673144D6211DBAD7001BDBF2 /* TiUIApplication.m in Sources */,
 				24CA8B97111161FE0084E2DE /* TiUIOptionDialogProxy.m in Sources */,
 				24CA8B98111161FE0084E2DE /* TiUINavBarButton.m in Sources */,
 				24CA8B99111161FE0084E2DE /* TiUILabelProxy.m in Sources */,

iphone/iphone/main.m

@@ -10,24 +10,25 @@
 //automatically replaced and built on the fly - when running in
 //XCode give some reasonable values
 
-NSString * const TI_APPLICATION_DEPLOYTYPE = @"development";
-NSString * const TI_APPLICATION_ID = @"com.appcelerator.kitchensink.xcode";
-NSString * const TI_APPLICATION_PUBLISHER = @"Appcelerator";
-NSString * const TI_APPLICATION_URL = @"http://www.appcelerator.com";
-NSString * const TI_APPLICATION_NAME = @"Kitchen Sink (XCode)";
-NSString * const TI_APPLICATION_VERSION = @"1.0";
-NSString * const TI_APPLICATION_DESCRIPTION = @"Kitchen Sink from XCode";
-NSString * const TI_APPLICATION_COPYRIGHT = @"Appcelerator";
-NSString * const TI_APPLICATION_GUID = @"25FE4B6E-7DA9-4344-B55B-25195570860F";
+NSString *const TI_APPLICATION_DEPLOYTYPE = @"development";
+NSString *const TI_APPLICATION_ID = @"com.appcelerator.kitchensink.xcode";
+NSString *const TI_APPLICATION_PUBLISHER = @"Appcelerator";
+NSString *const TI_APPLICATION_URL = @"http://www.appcelerator.com";
+NSString *const TI_APPLICATION_NAME = @"Kitchen Sink (XCode)";
+NSString *const TI_APPLICATION_VERSION = @"1.0";
+NSString *const TI_APPLICATION_DESCRIPTION = @"Kitchen Sink from XCode";
+NSString *const TI_APPLICATION_COPYRIGHT = @"Appcelerator";
+NSString *const TI_APPLICATION_GUID = @"25FE4B6E-7DA9-4344-B55B-25195570860F";
 BOOL const TI_APPLICATION_ANALYTICS = YES;
 BOOL const TI_APPLICATION_SHOW_ERROR_CONTROLLER = YES;
-NSString * const TI_APPLICATION_RESOURCE_DIR = nil;
-NSString * const TI_APPLICATION_BUILD_TYPE = nil;
+NSString *const TI_APPLICATION_RESOURCE_DIR = nil;
+NSString *const TI_APPLICATION_BUILD_TYPE = nil;
 
-int main(int argc, char *argv[]) {
+int main(int argc, char *argv[])
+{
 
-    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
-    int retVal = UIApplicationMain(argc, argv, nil, @"TiApp");
-    [pool release];
-    return retVal;
+  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  int retVal = UIApplicationMain(argc, argv, @"TiUIApplication", @"TiApp");
+  [pool release];
+  return retVal;
 }

support/iphone/main.m

@@ -7,27 +7,26 @@
 #define _QUOTEME(x) #x
 #define STRING(x) _QUOTEME(x)
 
-NSString * const TI_APPLICATION_DEPLOYTYPE = @"__DEPLOYTYPE__";
-NSString * const TI_APPLICATION_ID = @"__APP_ID__";
-NSString * const TI_APPLICATION_PUBLISHER = @"__APP_PUBLISHER__";
-NSString * const TI_APPLICATION_URL = @"__APP_URL__";
-NSString * const TI_APPLICATION_NAME = @"__APP_NAME__";
-NSString * const TI_APPLICATION_VERSION = @"__APP_VERSION__";
-NSString * const TI_APPLICATION_DESCRIPTION = @"__APP_DESCRIPTION__";
-NSString * const TI_APPLICATION_COPYRIGHT = @"__APP_COPYRIGHT__";
-NSString * const TI_APPLICATION_GUID = @"__APP_GUID__";
+NSString *const TI_APPLICATION_DEPLOYTYPE = @"__DEPLOYTYPE__";
+NSString *const TI_APPLICATION_ID = @"__APP_ID__";
+NSString *const TI_APPLICATION_PUBLISHER = @"__APP_PUBLISHER__";
+NSString *const TI_APPLICATION_URL = @"__APP_URL__";
+NSString *const TI_APPLICATION_NAME = @"__APP_NAME__";
+NSString *const TI_APPLICATION_VERSION = @"__APP_VERSION__";
+NSString *const TI_APPLICATION_DESCRIPTION = @"__APP_DESCRIPTION__";
+NSString *const TI_APPLICATION_COPYRIGHT = @"__APP_COPYRIGHT__";
+NSString *const TI_APPLICATION_GUID = @"__APP_GUID__";
 BOOL const TI_APPLICATION_ANALYTICS = __APP_ANALYTICS__;
 BOOL const TI_APPLICATION_SHOW_ERROR_CONTROLLER = __SHOW_ERROR_CONTROLLER__;
-NSString * const TI_APPLICATION_BUILD_TYPE = @"__APP_DEPLOY_TYPE__";
+NSString *const TI_APPLICATION_BUILD_TYPE = @"__APP_DEPLOY_TYPE__";
 
 #ifdef TARGET_IPHONE_SIMULATOR
-NSString * const TI_APPLICATION_RESOURCE_DIR = @"__APP_RESOURCE_DIR__";
+NSString *const TI_APPLICATION_RESOURCE_DIR = @"__APP_RESOURCE_DIR__";
 #endif
 
 int main(int argc, char *argv[]) {
-    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
-
-	int retVal = UIApplicationMain(argc, argv, nil, @"TiApp");
-    [pool release];
-    return retVal;
+  NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  int retVal = UIApplicationMain(argc, argv, @"TiUIApplication", @"TiApp");
+  [pool release];
+  return retVal;
 }