iOS device mode

This SDK built on top of analytics-ios will no longer receive updates. We recommend you use the MoEngage-Segment-Swift SDK built on top of analytics-swift. Refer to the MoEngage-Segment-Swift documentation for more details.

Installing SDK

MoEngage can be integrated via Twilio Segment using Cocoapods or with Swift Package Manager

Install Using CocoaPod

• Initialize pod with pod init command, this will create a podfile for your project.
• Update your podfile by adding pod ‘Twilio Segment-MoEngage ’ as shown below:
  Ruby

  use_frameworks!
  pod 'Twilio Segment-MoEngage’,'~>7.1.0'
  
• Update the pod. - pod update

Install using Swift Package Manager

Twilio Segment-MoEngage is supported through SPM from SDK version 7.1.0. To integrate use the following GitHub URL link and set the branch as master or version as 7.1.0 and above https://github.com/moengage/MoEngage-Twilio Segment-iOS.git

Setup Twilio Segment SDK

Now head to the App Delegate, and setup the Twilio Segment SDK :

Objective-C

#import <SEGMoEngageIntegrationFactory.h>
#import <SEGMoEngageInitializer.h>
#import <SEGAnalytics.h>
 
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    //Initialize SEGMoEngageInitializer
    MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID:@"YOUR Workspace ID"];
    [SEGMoEngageInitializer initializeDefaultInstance:sdkConfig];
    
    // Add your configuration key from Twilio Segment
    SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"configuration key"];
    
    // Add MoEngageIntegrationFactory. Without this data will not come to MoEngage.
    [config use:[SEGMoEngageIntegrationFactory instance]];
    [SEGAnalytics setupWithConfiguration:config];
 }

Please make sure to set the Data Center/ Region for MoEngage SDK separately in your AppDelegate’s application:didFinishLaunchingWithOptions method. Refer doc for more info.

Don’t miss to add [config use:[SEGMoEngageIntegrationFactory instance]] while setting up Twilio Segment SDK. Unless this is done data will not be sent to MoEngage.

Setup MoEngage

To setup MoEngage, do the following :

1. Navigate to MoEngage Dashboard > Settings > General.
2. Copy the Workspace ID.
3. Go to Twilio Segment dashboard , go to Integrations and select MoEngage.
4. Enable MoEngage Integration.
5. Go to MoEngage Settings and enter the MoEngage Workspace ID, obtained in Step1.
6. Save the changes.

These new settings will take up to an hour to propagate to all of your existing users. For new users, it is instantaneous! Twilio Segment-MoEngage Integration is a bundled integration, requires client-side integration.

Tracking User Attribute

User attributes are specific traits of a user, like email, username, mobile, gender etc. identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them.

Objective-C

[[SEGAnalytics sharedAnalytics] identify:@"a user's id"
                                traits:@{ @"email": @"a user's email address" }];

For more info refer to this link.

Tracking Events

Event tracking is used to track user behaviour in an app. track lets you record the actions your users perform. Every action triggers i.e,“event”, which can also have associated attributes.

Objective-C

[[SEGAnalytics sharedAnalytics] track:@"Item Purchased"
                           properties:@{ @"item": @"Sword of Heracles"}];

That’s all you need for tracking data. For more info refer this link.

Reset User

The reset method clears the SDK’s internal stores for the current user. This is useful for apps where users can log in and out with different identities over time.

Objective-C

[[SEGAnalytics sharedAnalytics] reset];

For more info refer to this link.

Push Notifications

Push Notifications are a great way to keep your users engaged and informed about your app. You have the following options while implementing push notifications in your app:

MoEngage Push Implementation

This will be the more preferred way of implementing since Twilio Segment SDK currently doesn’t support the UserNotifications framework which was introduced by Apple from iOS10. Follow this link to implement Push Notification in your mobile app using MoEngage SDK: Push Notifications

Please note that AppDelegate Swizzling does not work reliably with Twilio Segment Integration because of delay in initializing the SDK by Twilio Segment, therefore make sure to call the MoEngage SDK methods for all Push related callbacks.

Twilio Segment Push Implementation

With this approach, we have found that MoEngage SDK will be unable to process Notification when App is launched with a notification click. This is because of Twilio Segment SDK not providing the payload to MoEngage SDK in this particular scenario. Hence we would highly recommend you to use the first approach, where you will have to directly call the MoEngage SDK methods in Push related callbacks.

1. Follow the directions to register for push using the Twilio Segment SDK in this link.
2. In your application’s application:didReceiveRemoteNotification: method, add the following:

Objective-C

[[SEGAnalytics sharedAnalytics] receivedRemoteNotification:userInfo];

3. If you integrated the application:didReceiveRemoteNotification:fetchCompletionHandler: in your app, add the following to that method:

Objective-C

[[SEGAnalytics sharedAnalytics] receivedRemoteNotification:userInfo];

4. If you implemented handleActionWithIdentifier:forRemoteNotification:, add the following to that method:

[[SEGAnalytics sharedAnalytics] handleActionWithIdentifier:identifier forRemoteNotification:userInfo];

Install / Update Differentiation :

Since you might integrate us when your app is already on the App Store, we would need to know whether your app update would be an actual UPDATE or an INSTALL. To differentiate between those, use one of the methods below:

Objective-C

//For new Install call following
[[MoEngage sharedInstance]appStatus:AppStatusInstall]
//For an app update call following
[[MoEngage sharedInstance]appStatus:AppStatusUpdate];

For more info on this refer the following link.

InApp Native

In-App Messaging is custom views that you can send to a Twilio segment of users to show custom messages or give new offers or take to some specific pages. Follow the link to know more about inApp Messaging and how to implement it in your application: InApp NATIV

For more info on using Twilio Segment for iOS refer to Developer Docs provided by Twilio Segment.