feat: add custom events support (#1114)

fadi-george · github-actions[bot] · web-flow · commit 4943698916c6 · 2026-01-30T12:20:00.000-08:00
Co-authored-by: github-actions[bot] &lt;noreply@onesignal.com&gt;
diff --git a/android/build.gradle b/android/build.gradle
@@ -38,5 +38,5 @@ android {
 }
 
 dependencies {
-    implementation 'com.onesignal:OneSignal:5.4.2'
+    implementation 'com.onesignal:OneSignal:5.6.1'
 }
diff --git a/android/gradle/wrapper/gradle-wrapper.jar b/android/gradle/wrapper/gradle-wrapper.jar
diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,7 @@
-#Thu Oct 17 14:56:12 PDT 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
diff --git a/android/gradlew.bat b/android/gradlew.bat
diff --git a/android/src/main/java/com/onesignal/flutter/OneSignalUser.java b/android/src/main/java/com/onesignal/flutter/OneSignalUser.java
@@ -47,6 +47,7 @@ public void onMethodCall(MethodCall call, Result result) {
         else if (call.method.contentEquals("OneSignal#removeTags")) this.removeTags(call, result);
         else if (call.method.contentEquals("OneSignal#getTags")) this.getTags(call, result);
         else if (call.method.contentEquals("OneSignal#lifecycleInit")) this.lifecycleInit(result);
+        else if (call.method.contentEquals("OneSignal#trackEvent")) this.trackEvent(call, result);
         else replyNotImplemented(result);
     }
 
@@ -165,6 +166,13 @@ private void getTags(MethodCall call, Result result) {
         replySuccess(result, OneSignal.getUser().getTags());
     }
 
+    private void trackEvent(MethodCall call, Result result) {
+        String name = call.argument("name");
+        Map<String, Object> properties = call.argument("properties");
+        OneSignal.getUser().trackEvent(name, properties);
+        replySuccess(result, null);
+    }
+
     @Override
     public void onUserStateChange(UserChangedState userChangedState) {
         try {
diff --git a/build.gradle b/build.gradle
@@ -19,7 +19,7 @@ spotless {
   java {
     target 'android/**/*.java', 'example/android/app/**/*.java'
     targetExclude '**/build/**', '**/GeneratedPluginRegistrant.java'
-    palantirJavaFormat('2.28.0')
+    palantirJavaFormat('2.85.0')
     removeUnusedImports()
     trimTrailingWhitespace()
     endWithNewline()
diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock
@@ -2,49 +2,49 @@ PODS:
   - Flutter (1.0.0)
   - onesignal_flutter (5.3.4):
     - Flutter
-    - OneSignalXCFramework (= 5.2.16)
-  - OneSignalXCFramework (5.2.16):
-    - OneSignalXCFramework/OneSignalComplete (= 5.2.16)
-  - OneSignalXCFramework/OneSignal (5.2.16):
+    - OneSignalXCFramework (= 5.4.0)
+  - OneSignalXCFramework (5.4.0):
+    - OneSignalXCFramework/OneSignalComplete (= 5.4.0)
+  - OneSignalXCFramework/OneSignal (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalExtension
     - OneSignalXCFramework/OneSignalLiveActivities
     - OneSignalXCFramework/OneSignalNotifications
     - OneSignalXCFramework/OneSignalOSCore
     - OneSignalXCFramework/OneSignalOutcomes
     - OneSignalXCFramework/OneSignalUser
-  - OneSignalXCFramework/OneSignalComplete (5.2.16):
+  - OneSignalXCFramework/OneSignalComplete (5.4.0):
     - OneSignalXCFramework/OneSignal
     - OneSignalXCFramework/OneSignalInAppMessages
     - OneSignalXCFramework/OneSignalLocation
-  - OneSignalXCFramework/OneSignalCore (5.2.16)
-  - OneSignalXCFramework/OneSignalExtension (5.2.16):
+  - OneSignalXCFramework/OneSignalCore (5.4.0)
+  - OneSignalXCFramework/OneSignalExtension (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalOutcomes
-  - OneSignalXCFramework/OneSignalInAppMessages (5.2.16):
+  - OneSignalXCFramework/OneSignalInAppMessages (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalNotifications
     - OneSignalXCFramework/OneSignalOSCore
     - OneSignalXCFramework/OneSignalOutcomes
     - OneSignalXCFramework/OneSignalUser
-  - OneSignalXCFramework/OneSignalLiveActivities (5.2.16):
+  - OneSignalXCFramework/OneSignalLiveActivities (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalOSCore
     - OneSignalXCFramework/OneSignalUser
-  - OneSignalXCFramework/OneSignalLocation (5.2.16):
+  - OneSignalXCFramework/OneSignalLocation (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalNotifications
     - OneSignalXCFramework/OneSignalOSCore
     - OneSignalXCFramework/OneSignalUser
-  - OneSignalXCFramework/OneSignalNotifications (5.2.16):
+  - OneSignalXCFramework/OneSignalNotifications (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalExtension
     - OneSignalXCFramework/OneSignalOutcomes
-  - OneSignalXCFramework/OneSignalOSCore (5.2.16):
+  - OneSignalXCFramework/OneSignalOSCore (5.4.0):
     - OneSignalXCFramework/OneSignalCore
-  - OneSignalXCFramework/OneSignalOutcomes (5.2.16):
+  - OneSignalXCFramework/OneSignalOutcomes (5.4.0):
     - OneSignalXCFramework/OneSignalCore
-  - OneSignalXCFramework/OneSignalUser (5.2.16):
+  - OneSignalXCFramework/OneSignalUser (5.4.0):
     - OneSignalXCFramework/OneSignalCore
     - OneSignalXCFramework/OneSignalNotifications
     - OneSignalXCFramework/OneSignalOSCore
@@ -67,8 +67,8 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   Flutter: cabc95a1d2626b1b06e7179b784ebcf0c0cde467
-  onesignal_flutter: 1c287b13a09745d60ce7c82a9e80b1dce8e56e64
-  OneSignalXCFramework: 8ed6648481bee0bd973a138fecd80331b798524f
+  onesignal_flutter: d9678a4f6766dbb8482d651a61e9daf292fa43e7
+  OneSignalXCFramework: 95b6391df5a91b448003149c1a633ade42ceca1e
 
 PODFILE CHECKSUM: 008ee3527530ade7ae7311fc02a615df31949c2e
 
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:io';
 
 import 'package:flutter/material.dart';
 import 'package:onesignal_flutter/onesignal_flutter.dart';
@@ -144,6 +145,43 @@ class _MyAppState extends State<MyApp> {
     print(tags);
   }
 
+  void _handleTrackEvent() {
+    print("Tracking events");
+
+    // Detect platform
+    String platform = Platform.isAndroid
+        ? 'android'
+        : Platform.isIOS
+            ? 'ios'
+            : 'unknown';
+
+    // Track event without properties
+    OneSignal.User.trackEvent("Flutter-$platform-noprops");
+
+    // Track event with properties
+    OneSignal.User.trackEvent("Flutter-$platform", {
+      "someNum": 123,
+      "someFloat": 3.14159,
+      "someString": "abc",
+      "someBool": true,
+      "someObject": {
+        "abc": "123",
+        "nested": {
+          "def": '456',
+        },
+        "ghi": null,
+      },
+      "someArray": [1, 2],
+      "someMixedArray": [
+        1,
+        "2",
+        {"abc": "123"},
+        null,
+      ],
+      "someNull": null,
+    });
+  }
+
   void _handlePromptForPushPermission() {
     print("Prompting for Permission");
     OneSignal.Notifications.requestPermission(true);
@@ -326,6 +364,10 @@ class _MyAppState extends State<MyApp> {
                     new OneSignalButton(
                         "Get Tags", _handleGetTags, !_enableConsentButton)
                   ]),
+                  new TableRow(children: [
+                    new OneSignalButton(
+                        "Track Event", _handleTrackEvent, !_enableConsentButton)
+                  ]),
                   new TableRow(children: [
                     new OneSignalButton("Prompt for Push Permission",
                         _handlePromptForPushPermission, !_enableConsentButton)
diff --git a/ios/Classes/OSFlutterUser.m b/ios/Classes/OSFlutterUser.m
@@ -76,6 +76,8 @@ - (void)handleMethodCall:(FlutterMethodCall *)call
     [self addSms:call withResult:result];
   else if ([@"OneSignal#removeSms" isEqualToString:call.method])
     [self removeSms:call withResult:result];
+  else if ([@"OneSignal#trackEvent" isEqualToString:call.method])
+    [self trackEvent:call withResult:result];
   else if ([@"OneSignal#lifecycleInit" isEqualToString:call.method])
     [self lifecycleInit:call withResult:result];
   else
@@ -145,6 +147,18 @@ - (void)removeSms:(FlutterMethodCall *)call withResult:(FlutterResult)result {
   result(nil);
 }
 
+- (void)trackEvent:(FlutterMethodCall *)call withResult:(FlutterResult)result {
+  NSString *name = call.arguments[@"name"];
+  NSDictionary *properties = call.arguments[@"properties"];
+
+  if (properties == (id)[NSNull null]) {
+    properties = nil;
+  }
+
+  [OneSignal.User trackEventWithName:name properties:properties];
+  result(nil);
+}
+
 - (void)lifecycleInit:(FlutterMethodCall *)call
            withResult:(FlutterResult)result {
   [OneSignal.User removeObserver:self];
diff --git a/ios/onesignal_flutter.podspec b/ios/onesignal_flutter.podspec
@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
   s.dependency 'Flutter'
-  s.dependency 'OneSignalXCFramework', '5.2.16'
+  s.dependency 'OneSignalXCFramework', '5.4.0'
   s.ios.deployment_target = '11.0'
   s.static_framework = true
 end
diff --git a/lib/src/user.dart b/lib/src/user.dart
@@ -1,8 +1,8 @@
 import 'dart:async';
-import 'package:flutter/services.dart';
 
-import 'package:onesignal_flutter/src/utils.dart';
+import 'package:flutter/services.dart';
 import 'package:onesignal_flutter/src/pushsubscription.dart';
+import 'package:onesignal_flutter/src/utils.dart';
 
 typedef void OnUserChangeObserver(OSUserChangedState stateChanges);
 
@@ -19,8 +19,10 @@ class OSUserState extends JSONStringRepresentable {
   }
 
   String jsonRepresentation() {
-    return convertToJsonString(
-        {'onesignalId': this.onesignalId, 'externalId': this.externalId});
+    return convertToJsonString({
+      'onesignalId': this.onesignalId,
+      'externalId': this.externalId,
+    });
   }
 }
 
@@ -60,8 +62,9 @@ class OneSignalUser {
   /// Sets the user's language to [language] this also applies to
   /// the email and/or SMS player if those are logged in on the device.
   Future<void> setLanguage(String language) async {
-    return await _channel
-        .invokeMethod("OneSignal#setLanguage", {'language': language});
+    return await _channel.invokeMethod("OneSignal#setLanguage", {
+      'language': language,
+    });
   }
 
   /// Set an [alias] for the current user.
@@ -122,8 +125,9 @@ class OneSignalUser {
 
   /// Returns the local tags of the current user.
   Future<Map<String, String>> getTags() async {
-    Map<dynamic, dynamic> tags =
-        await _channel.invokeMethod("OneSignal#getTags");
+    Map<dynamic, dynamic> tags = await _channel.invokeMethod(
+      "OneSignal#getTags",
+    );
     return tags.cast<String, String>();
   }
 
@@ -165,6 +169,18 @@ class OneSignalUser {
     return await _channel.invokeMethod("OneSignal#getOnesignalId");
   }
 
+  /// Track a custom event for the current user.
+  ///
+  /// [name] is the event name to track.
+  /// [properties] is an optional map of custom properties associated with the event.
+  Future<void> trackEvent(String name,
+      [Map<String, dynamic>? properties]) async {
+    return await _channel.invokeMethod("OneSignal#trackEvent", {
+      'name': name,
+      'properties': properties,
+    });
+  }
+
   /// Add an observer that fires when the OneSignal User state changes.
   /// *Important* When using the observer to retrieve the onesignalId, check the
   /// externalId as well to confirm the values are associated with the expected user.*
@@ -185,7 +201,8 @@ class OneSignalUser {
   Future<Null> _handleMethod(MethodCall call) async {
     if (call.method == 'OneSignal#onUserStateChange') {
       this._onUserStateChange(
-          OSUserChangedState(call.arguments.cast<String, dynamic>()));
+        OSUserChangedState(call.arguments.cast<String, dynamic>()),
+      );
     }
     return null;
   }
diff --git a/test/mock_channel.dart b/test/mock_channel.dart
@@ -383,6 +383,12 @@ class OneSignalMockChannelController {
         state.lifecycleInitCalled = true;
         state.userLifecycleInitCalled = true;
         break;
+      case "OneSignal#trackEvent":
+        final args = call.arguments as Map<dynamic, dynamic>;
+        state.trackedEventName = args['name'] as String?;
+        state.trackedEventProperties =
+            args['properties'] as Map<dynamic, dynamic>?;
+        break;
     }
   }
 }
@@ -485,6 +491,10 @@ class OneSignalState {
   String? removedSms;
   bool? userLifecycleInitCalled;
 
+  // events
+  String? trackedEventName;
+  Map<dynamic, dynamic>? trackedEventProperties;
+
   /*
     All of the following functions parse the MethodCall
     parameters, and sets properties on the object itself
diff --git a/test/user_test.dart b/test/user_test.dart
@@ -291,6 +291,37 @@ void main() {
       expect(controller.state.lifecycleInitCalled, true);
     });
 
+    group('trackEvent', () {
+      test('invokes native method with event name only', () async {
+        await user.trackEvent('purchase');
+
+        expect(controller.state.trackedEventName, 'purchase');
+        expect(controller.state.trackedEventProperties, isNull);
+      });
+
+      test('invokes native method with event name and properties', () async {
+        await user.trackEvent('purchase', {
+          'amount': 99.99,
+          'currency': 'USD',
+          'item_count': 3,
+        });
+
+        expect(controller.state.trackedEventName, 'purchase');
+        expect(controller.state.trackedEventProperties, {
+          'amount': 99.99,
+          'currency': 'USD',
+          'item_count': 3,
+        });
+      });
+
+      test('handles empty properties map', () async {
+        await user.trackEvent('page_view', {});
+
+        expect(controller.state.trackedEventName, 'page_view');
+        expect(controller.state.trackedEventProperties, {});
+      });
+    });
+
     group('observers', () {
       test('can add observer', () {
         bool observerCalled = false;

Original file line number	Diff line number	Diff line change
`@@ -38,5 +38,5 @@ android {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`dependencies {`
`41`		`- implementation 'com.onesignal:OneSignal:5.4.2'`
	`41`	`+ implementation 'com.onesignal:OneSignal:5.6.1'`
`42`	`42`	`}`