MOEN-33225 Cards fetch on login

cards/moengage_cards/CHANGELOG.md

@@ -1,5 +1,15 @@
 # MoEngage Cards Plugin
 
+# Next Release date
+
+## Next version
+- Refresh cards on uniqueID set
+- Breaking Change: 
+
+|                     Then                      |            Now                     |
+|:---------------------------------------------:|:----------------------------------:|
+| MoEngageCards#setAppOpenCardsSyncListener()   | MoEngageCards#setSyncCompleteListener() |
+
 # 15-07-2024
 
 ## 3.1.1

cards/moengage_cards/README.md

@@ -44,11 +44,11 @@ moe.MoEngageCards cards = moe.MoEngageCards("<MOE_APP_ID>");
 cards.initialize();
 ```
 
-Set App Open Cards Sync Listener
+Set Cards Sync complete callback listener
 
 ```
-cards.setAppOpenCardsSyncListener((data) {
-      debugPrint("Cards App Open Sync Listener: $data");
+cards.setSyncCompleteListener((data) {
+      debugPrint("Cards Sync Listener: $data");
 });
 ```
 

cards/moengage_cards/lib/src/moengage_cards.dart

@@ -123,9 +123,9 @@ class MoEngageCards {
     return _cardsPlatform.getUnClickedCardsCount(_appId);
   }
 
-  /// Listener for Cards App Open Sync Listener
+  /// Set cards sync complete callback listener
   /// [cardsSyncListener] - Callback for Card Sync Completion of type [CardsSyncListener]
-  void setAppOpenCardsSyncListener(CardsSyncListener cardsSyncListener) {
-    _cardsPlatform.setAppOpenCardsSyncListener(cardsSyncListener, _appId);
+  void setSyncCompleteListener(CardsSyncListener cardsSyncListener) {
+    _cardsPlatform.setSyncCompleteListener(cardsSyncListener, _appId);
   }
 }

cards/moengage_cards_android/CHANGELOG.md

@@ -1,5 +1,10 @@
 # MoEngage Cards Android Plugin
 
+# Next Release date
+
+## Next version
+- Refresh cards on uniqueID set
+
 # 15-07-2024
 
 ## 2.1.1

cards/moengage_cards_android/android/src/main/kotlin/com/moengage/flutter/cards/Constants.kt

@@ -21,4 +21,4 @@ internal const val METHOD_FETCH_CARDS = "fetchCards"
 
 internal const val METHOD_INBOX_OPEN_CARDS_SYNC = "onInboxOpenCardsSync"
 internal const val METHOD_PULL_TO_REFRESH_CARDS_SYNC = "onPullToRefreshCardsSync"
-internal const val METHOD_APP_OPEN_CARDS_SYNC = "onAppOpenCardsSync"
+internal const val METHOD_GENERIC_CARDS_SYNC = "onCardsSync"

cards/moengage_cards_android/android/src/main/kotlin/com/moengage/flutter/cards/EventEmitterImpl.kt

@@ -33,7 +33,7 @@ class EventEmitterImpl(private val callBack: (methodName: String, payload: Strin
             }
             val syncCompleteJson = cardsSyncToJson(syncCompleteData, event.accountMeta)
             val method = when (event.cardEventType) {
-                CardEventType.APP_OPEN_SYNC -> METHOD_APP_OPEN_CARDS_SYNC
+                CardEventType.GENERIC_SYNC -> METHOD_GENERIC_CARDS_SYNC
                 CardEventType.INBOX_OPEN_SYNC -> METHOD_INBOX_OPEN_CARDS_SYNC
                 CardEventType.PULL_TO_REFRESH_SYNC -> METHOD_PULL_TO_REFRESH_CARDS_SYNC
             }

cards/moengage_cards_ios/CHANGELOG.md

@@ -1,5 +1,10 @@
 # MoEngage Cards iOS Plugin
 
+# Next Release date
+
+## Next version
+- Refresh cards on uniqueID set
+
 # 03-07-2024
 
 ## 2.2.0

cards/moengage_cards_ios/lib/moengage_cards_ios.dart

@@ -40,11 +40,9 @@ class MoEngageCardsIOS extends MoEngageCardsPlatform {
   }
 
   @override
-  void setAppOpenCardsSyncListener(
-    CardsSyncListener cardsSyncListener,
-    String appId,
-  ) {
-    super.setAppOpenCardsSyncListener(cardsSyncListener, appId);
+  void setSyncCompleteListener(
+      CardsSyncListener cardsSyncListener, String appId) {
+    super.setSyncCompleteListener(cardsSyncListener, appId);
     methodChannel.invokeMethod(
       methodSetAppOpenCardsSyncListener,
       getAccountMeta(appId),

cards/moengage_cards_platform_interface/CHANGELOG.md

@@ -1,5 +1,10 @@
 # MoEngage Cards Platform Interface
 
+# Next Release date
+
+## Next version
+- Refresh cards on uniqueID set
+
 # 21-03-2024
 
 ## 2.0.0

cards/moengage_cards_platform_interface/lib/moengage_cards_platform_interface.dart

@@ -116,12 +116,10 @@ abstract class MoEngageCardsPlatformInterface extends PlatformInterface {
   Future<int> getUnClickedCardsCount(String appId) async =>
       throw UnimplementedError();
 
-  /// Listener for Cards App Open Sync Listener
+  /// Listener for Cards Sync Listener whenever MoEngage SDK syncs the cards
   /// [cardsSyncListener] - Callback for Card Sync Completion of type [CardsSyncListener]
   /// [appId] - MoEngage App ID
-  void setAppOpenCardsSyncListener(
-    CardsSyncListener cardsSyncListener,
-    String appId,
-  ) =>
+  void setSyncCompleteListener(
+          CardsSyncListener cardsSyncListener, String appId) =>
       throw UnimplementedError();
 }

cards/moengage_cards_platform_interface/lib/src/internal/callback_cache.dart

@@ -2,8 +2,9 @@ import '../../moengage_cards_platform_interface.dart';
 
 /// Callback Cache for Cards Module
 class CallbackCache {
-  /// App Open Cards Sync Listener
-  CardsSyncListener? appOpenSyncListener;
+  /// Set cards sync complete callback listener
+  /// Currently applicable for AppOpen Sync, fetching cards when unique id is set.
+  CardsSyncListener? cardsSyncListener;
 
   /// Inbox Open Cards Sync Listener
   CardsSyncListener? inboxOpenSyncListener;

cards/moengage_cards_platform_interface/lib/src/internal/cards_controller.dart

@@ -38,14 +38,14 @@ class CardsController {
             .getCallbackCacheForInstance(accountMeta.appId)
             .pullToRefreshOpenSyncListener
             ?.call(data);
-      } else if (call.method == methodOnAppOpenCardsSync) {
+      } else if (call.method == methodOnCardsSync) {
         final syncJson = json[keyData]?[keySyncCompleteData];
         final SyncCompleteData? data = (syncJson != null)
             ? SyncCompleteData.fromJson(syncJson as Map<String, dynamic>)
             : null;
         CardsInstanceProvider()
             .getCallbackCacheForInstance(accountMeta.appId)
-            .appOpenSyncListener
+            .cardsSyncListener
             ?.call(data);
       } else if (call.method == methodOnInboxOpenCardsSync) {
         final syncJson = json?[keyData]?[keySyncCompleteData];

cards/moengage_cards_platform_interface/lib/src/internal/cards_platform.dart

@@ -22,12 +22,10 @@ abstract class MoEngageCardsPlatform extends MoEngageCardsPlatformInterface {
   }
 
   @override
-  void setAppOpenCardsSyncListener(
-    CardsSyncListener cardsSyncListener,
-    String appId,
-  ) {
+  void setSyncCompleteListener(
+      CardsSyncListener cardsSyncListener, String appId) {
     CardsInstanceProvider()
         .getCallbackCacheForInstance(appId)
-        .appOpenSyncListener = cardsSyncListener;
+        .cardsSyncListener = cardsSyncListener;
   }
 }

cards/moengage_cards_platform_interface/lib/src/internal/constants.dart

@@ -93,10 +93,11 @@ const String methodNewCardsCount = 'getNewCardsCount';
 const String methodUnClickedCardsCount = 'unClickedCardsCount';
 const String methodOnInboxOpenCardsSync = 'onInboxOpenCardsSync';
 const String methodPullToRefreshCardsSync = 'onPullToRefreshCardsSync';
-const String methodOnAppOpenCardsSync = 'onAppOpenCardsSync';
+const String methodOnCardsSync = 'onCardsSync';
 
 //JSON Values Constants
 const String argumentPullToRefreshSync = 'PULL_TO_REFRESH';
 const String argumentInboxOpenSync = 'INBOX_OPEN';
 const String argumentAppOpenSync = 'APP_OPEN';
 const String argumentAllCards = 'All';
+const String argumentImmediateSync = 'IMMEDIATE';

cards/moengage_cards_platform_interface/lib/src/internal/payload_mapper.dart

@@ -114,6 +114,8 @@ SyncType syncTypeFromString(String? syncType) {
       return SyncType.inboxOpen;
     case argumentAppOpenSync:
       return SyncType.appOpen;
+    case argumentImmediateSync:
+      return SyncType.immediate;
     default:
       throw UnimplementedError('Sync Type Not Supported');
   }
@@ -127,6 +129,8 @@ String syncTypeToString(SyncType syncType) {
       return argumentInboxOpenSync;
     case SyncType.appOpen:
       return argumentAppOpenSync;
+    case SyncType.immediate:
+      return argumentImmediateSync;
   }
 }
 

cards/moengage_cards_platform_interface/lib/src/model/sync_type.dart

@@ -7,5 +7,9 @@ enum SyncType {
   inboxOpen,
 
   /// Sync when user performs pull to refresh action
-  pullToRefresh
+  pullToRefresh,
+
+  /// Sync type when SDK sync the cards immediately.
+  /// Currently applicable for SDK fetching cards immediately when uniqueId is set
+  immediate
 }

example/android/build.gradle

@@ -1,7 +1,6 @@
 buildscript {
   ext.kotlin_version = '1.9.23'
   repositories {
-    mavenLocal()
     google()
     jcenter()
     maven { url 'https://developer.huawei.com/repo/' }

example/lib/cards/cards_home.dart

@@ -18,8 +18,8 @@ class _CardsHomeState extends State<CardsHome> {
   @override
   void initState() {
     super.initState();
-    cards.setAppOpenCardsSyncListener((moe.SyncCompleteData? data) {
-      debugPrint('Cards App Open Sync Listener: $data');
+    cards.setSyncCompleteListener((moe.SyncCompleteData? data) {
+      debugPrint('Cards Sync Listener: $data');
     });
     cards.initialize();
   }

example/lib/cards/cards_screen.dart

@@ -27,8 +27,8 @@ class _CardsScreenState extends State<CardsScreen>
   @override
   void initState() {
     super.initState();
-    cards.setAppOpenCardsSyncListener((moe.SyncCompleteData? data) {
-      debugPrint('Cards App Open Sync Listener Callback: $data');
+    cards.setSyncCompleteListener((moe.SyncCompleteData? data) {
+      debugPrint('Cards Sync Listener Callback: $data');
     });
     setUpTabs();
     cards.onCardsSectionLoaded((moe.SyncCompleteData? data) {