MoEngage SDK version 12, 8 document update

umangmoe · umangmoe · commit b7dd243ec0db · 2022-03-25T15:21:53.000+05:30
diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md
@@ -11,7 +11,7 @@ The Segment-MoEngage Integration is a bundled integration, meaning it requires t
 ## Setup MoEngage in your Segment Workspace:
 
 To setup MoEngage do the following :
-  1. First get your key([AppID](http://app.moengage.com/v3/#/settings/0/0)) from the MoEngage dashboard.
+  1. First get your key(AppID) from the MoEngage dashboard, `Dashboard --> Settings --> App --> General`.
   2. Go to your **Segment workspace**, go to **Destinations** and select **MoEngage**.
   3. Enable the MoEngage Destination.
   4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in **Step1**.
@@ -43,14 +43,22 @@ To get started with MoEngage on iOS, first integrate your app with the [MoEngage
 
 ### Configure the Segment SDK:
 
-Now head to the App Delegate file, and setup the Segment SDK by adding `SEGMoEngageIntegrationFactory` instance to the `SEGAnalyticsConfiguration` as shown below:
+Now head to the App Delegate file, and setup the Segment SDK by
+1. Importing `SEGMoEngageIntegrationFactory.h` and `SEGMoEngageInitializer.h`.
+2. Initialize `MOSDKConfig` object and call `initializeDefaultInstance:` method of `SEGMoEngageInitializer`.
+3. Initialize `SEGMoEngageIntegrationFactory` instance to the `SEGAnalyticsConfiguration` as shown below:
 
  ```objc
- #import <SEGMoEngageIntegrationFactory.h> // This line is key for MoEngage integration
+ #import <SEGMoEngageIntegrationFactory.h>
+ #import <SEGMoEngageInitializer.h>
  #import <SEGAnalytics.h>
 
  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 
+    //Initialize SDKConfig object and call initializeDefaultInstance: method of SEGMoEngageInitializer
+    MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID:@"YOUR APP ID"];
+    [SEGMoEngageInitializer initializeDefaultInstance:sdkConfig];
+    
     // Add your configuration key from Segment
     SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"configuration key"];
 
@@ -100,17 +108,17 @@ To differentiate between those, use one of the method below:
 
  ```objc
  //For new Install call following
- [[MoEngage sharedInstance] appStatus:INSTALL];
+ [[MoEngage sharedInstance] appStatus:AppStatusInstall];
 
  //For an app update call following
- [[MoEngage sharedInstance] appStatus:UPDATE];
+ [[MoEngage sharedInstance] appStatus:AppStatusUpdate];
  ```
 
-Read more on [install/update differentiation](https://docs.moengage.com/docs/installupdate-differentiation).
+Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620).
 
 ### Set the data center
 
-By default, the data center setting in the SDK is set to `DATA_CENTER_01`. Follow the steps in the [MoEngage - Data Redirection](https://docs.moengage.com/docs/data-redirection) to update the data center value. If not set correctly, several features of the MoEngage SDK will not function.
+By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Redirection](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center) to update the data center value. If not set correctly, several features of the MoEngage SDK will not function.
 
 ### Using features provided in the MoEngage SDK
 
@@ -139,19 +147,19 @@ Push Notifications are a great way to keep your users engaged and informed about
   ```
 
 **MoEngage Push Implementation:**
-For information about the MoEngage push implementation, see [**Push Notifications**](https://docs.moengage.com/docs/push-notifications) in the MoEngage documentation.
+For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756) in the MoEngage documentation.
 
 
 #### In-app messaging
-In-App Messages are custom views which you can send to a set of users to show custom messages,  give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://docs.moengage.com/docs/in-app-nativ)
+In-App Messages are custom views which you can send to a set of users to show custom messages,  give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ)
 
 
 #### Cards
-Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://docs.moengage.com/docs/ios-cards).
+Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS).
 
 
 #### Compliance
-To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://docs.moengage.com/docs/gdpr-compliance-1).
+To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation).
 
 ### Segment Docs
 For more info on using **Segment for iOS** refer to [**Developer Docs**](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment.
@@ -180,9 +188,9 @@ The MoEngage SDK depends on the below Jetpack libraries provided by Google for i
  done already.
 
 ```groovy
-    implementation("androidx.core:core:1.3.1")
-    implementation("androidx.appcompat:appcompat:1.2.0")
-    implementation("androidx.lifecycle:lifecycle-process:2.2.0")
+    implementation("androidx.core:core:1.6.0")
+    implementation("androidx.appcompat:appcompat:1.3.1")
+    implementation("androidx.lifecycle:lifecycle-process:2.4.0")
 ```
 Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration) documentation to know more about the build config and other libraries used by the SDK.
 
@@ -216,22 +224,33 @@ Copy the APP ID from the Settings Page `Dashboard --> Settings --> App --> Gener
 MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXXX")
             .enableSegmentIntegration()
             .build();
-MoEngage.initialize(moEngage);
+MoEngage.initialiseDefaultInstance(moEngage);
 ```
+### Exclude MoEngage Storage File from Auto-Backup
+Auto backup service of Andriod periodically backs up the Shared Preference file, Database files, and so on.
+
+For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup).
+
+The backup results in MoEngage SDK identifiers to be backed up and restored after re-install.
+The restoration of the identifier results in your data being corrupted and the user not being reachable using push notifications.
+
+To ensure data is not corrupted after a backup is restored, opt-out of MoEngage SDK storage files.
+
+Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup) for further details. 
 
 ### Install or update differentiation
 This is required for migrations to the MoEngage Platform so the SDK can determine whether the user is a new user on your app, or an existing user who updated to the latest version.
 
 If the user was already using your application and has just updated to a new version which has the MoEngage SDK, below is an example call:
 
 ```java
-MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.UPDATE);
+ MoEAnalyticsHelper.INSTANCE.setAppStatus(context, AppStatus.UPDATE);
 ```
 
 If this is a fresh install:
 
 ```java
-MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.INSTALL);
+MoEAnalyticsHelper.INSTANCE.setAppStatus(context, AppStatus.INSTALL);
 ```
 
 ### Configure Push Notifications
@@ -243,18 +262,18 @@ Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. T
 
 To display push notifications, some metadata regarding the notification is required. For example, the small icon and large icon drawables are mandatory.
 
-Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/core/com.moengage.core.config/-notification-config/index.html) API reference for all the possible options.
+Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/com.moengage.core.config/-notification-config/index.html) API reference for all the possible options.
 
 Use the `configureNotificationMetaData()` to pass on the configuration to the SDK.
 
 
 ```java
 MoEngage moEngage =
         new MoEngage.Builder(this, "XXXXXXXXXX")
-            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true))
+            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon))
             .enablePartnerIntegration(IntegrationPartner.SEGMENT)
             .build();
-MoEngage.initialize(moEngage);
+MoEngage.initialiseDefaultInstance(moEngage);
 ```
 
 #### Configuring Firebase Cloud Messaging
@@ -272,11 +291,11 @@ To opt-out of MoEngage token registration mechanism disable token registration w
 
 ```java
 MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXX")
-            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true))
+            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon))
             .configureFcm(FcmConfig(false))
             .enablePartnerIntegration(IntegrationPartner.SEGMENT)
             .build();
-MoEngage.initialize(moEngage);
+MoEngage.initialiseDefaultInstance(moEngage);
 ```
 
 ###### Pass the push token to the MoEngage SDK
@@ -297,8 +316,8 @@ Before passing the payload to the MoEngage SDK you should check if the payload i
 
 ```java
 if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.getData())) {
-  MoEFireBaseHelper.Companion.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData());
-}else{
+  MoEFireBaseHelper.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData());
+} else {
   // your app's business logic to show notification
 }
 ```
@@ -321,10 +340,26 @@ An application can get this callback by implementing `FirebaseEventListener` and
 
 Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference/moe-push-firebase/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html) for more details on the listener.
 
+##### Callbacks
+
+We recommend you to add the callbacks in the onCreate() of the Application class since these callbacks can be triggered even when the application is in the background.
+
+###### Token Callback
+
+When MoEngage SDK handles push registration it optionally provides a callback to the application whenever a new token is registered or the token is refreshed. To get the token callback implement the [TokenAvailableListener](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html).
+
+###### Non-MoEngage Payload
+
+If you are using the receiver provided by the SDK in your application's manifest file, SDK provides a callback in case a push payload is received for any other server apart from MoEngage Platform. To get a callback implement the [NonMoEngagePushListener](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html).
 
 
 #### Declare and configure Rich Landing Activity:
 
+A rich landing page can be used to open a web URL inside the app via a push campaign.
+
+The below configuration is only required if you want to add a parent activity to the Rich landing page, if not you can move to the next section.
+To use a rich landing page you need to add the below code in the AndroidManifest.xml
+
 Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of the parent
  activity; `[ACTIVITY_NAME]` with the activity name which should be the parent of the Rich Landing Page
 
