This is Xamarin.iOS sample application to demonstrate usage of Xamarin binding library of WebEngage iOS SDK.
-
Download WebEngage Xamarin iOS Library (v0.3.0.0).
-
To consume this downloaded .DLL in your Xamarin.iOS app, you must first add a reference to your Xamarin.iOS project by right-clicking on the References node of your project and select Add Reference.
- Add the following entries in info.plist file of your application.
WEGLicenseCode: YOUR-WEBENGAGE-LICENSE-CODE
WEGLogLevel: VERBOSE
- Initialize WebEngage SDK from FinishedLaunching callback of your AppDelegate class as shown below.
...
using WebEngageXamariniOS;
namespace YourNamespace
{
[Register("AppDelegate")]
public class AppDelegate : UIApplicationDelegate
{
...
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
...
WebEngage.SharedInstance().Application(application, launchOptions);
return true;
}
...
}
}- Login and logout users as shown in below example.
...
using WebEngageXamariniOS;
namespace YourNamespace
{
...
public partial class YourViewController : UIViewController
{
...
// Login
WebEngage.SharedInstance().User.Login("user-id");
// Logout
WebEngage.SharedInstance().User.Logout();
...
}
...
}- Set system user attributes as shown below.
using WebEngageXamariniOS;
namespace YourNamespace
{
...
public partial class YourViewController : UIViewController
{
...
// First name
WebEngage.SharedInstance().User.SetFirstName("John");
// Last name
WebEngage.SharedInstance().User.SetLastName("Doe");
// Email
WebEngage.SharedInstance().User.SetEmail("john.doe@gmail.com");
// Hashed email
WebEngage.SharedInstance().User.SetHashedEmail("144e0424883546e07dcd727057fd3b62");
// Phone
WebEngage.SharedInstance().User.SetPhone("john.doe@gmail.com");
// Hashed phone
WebEngage.SharedInstance().User.SetHashedPhone("e0ec043b3f9e198ec09041687e4d4e8d");
// Gender
WebEngage.SharedInstance().User.SetGender("male");
// Birthdate
WebEngage.SharedInstance().User.SetBirthDateString("1994-04-29");
// Company
WebEngage.SharedInstance().User.SetCompany("Alphabet Inc.");
// Opt-in
WebEngage.SharedInstance().User.SetOptInStatusForChannel(WEGEngagementChannel.Push, true);
WebEngage.SharedInstance().User.SetOptInStatusForChannel(WEGEngagementChannel.InApp, true);
WebEngage.SharedInstance().User.SetOptInStatusForChannel(WEGEngagementChannel.Sms, true);
WebEngage.SharedInstance().User.SetOptInStatusForChannel(WEGEngagementChannel.Email, true);
// Location
NSNumber latitude = 72.5;
NSNumber longitude = 120.5;
WebEngage.SharedInstance().User.SetUserLocation(latitude, longitude);
...
}
...
}- Set custom user attributes as shown below.
...
using WebEngageXamariniOS;
namespace YourNamespace
{
...
public partial class YourViewController : UIViewController
{
...
// String custom user attribute
WebEngage.SharedInstance().User.SetAttribute("Twitter username", "johndoe86@orig");
// Number custom user attribute
WebEngage.SharedInstance().User.SetAttribute("age", 24);
// Date custom user attribute
NSDateComponents dateComponents = new NSDateComponents
{
Day = 29,
Month = 4,
Year = 2001
};
NSCalendar calendar = NSCalendar.CurrentCalendar;
NSDate date = calendar.DateFromComponents(dateComponents);
WebEngage.SharedInstance().User.SetAttribute("Last order date", date);
// Complex custom user attributes
NSDictionary<NSString, NSObject> dict = new NSDictionary<NSString, NSObject>();
dict.SetValueForKey(new NSString("Z-62"), new NSString("Flat"));
dict.SetValueForKey(new NSString("Pennant Court"), new NSString("Building"));
dict.SetValueForKey(new NSString("Penn Road"), new NSString("Locality"));
dict.SetValueForKey(new NSString("West Midlands"), new NSString("State"));
dict.SetValueForKey(new NSString("WV30DT"), new NSString("PIN"));
WebEngage.SharedInstance().User.SetAttribute("Address", dict);
...
}
...
}Note: WebEngage Xamarin.iOS SDK only supports the following data-types: string, NSString, NSNumber, Boolean, NSDate, NSMutableArray and NSDictionary.
- Delete custom user attributes as shown below.
using WebEngageXamariniOS;
...
WebEngage.SharedInstance().User.DeleteAttribute("age");Track custom events as shown below.
using WebEngageXamariniOS;
...
// Simple event
WebEngage.SharedInstance().Analytics.TrackEventWithName("Product Viewed");
// Event with attributes
var addedToCartAttributes = new NSDictionary("Product ID", 1337,
"Price", 39.80,
"Quantity", 1,
"Product", "Givenchy Pour Homme Cologne",
"Category", "Fragrance",
"Currency", "USD",
"Is Premium", true
);
WebEngage.SharedInstance().Analytics.TrackEventWithName("Added to Cart", addedToCartAttributes);
// Complex event
var detailsProduct1 = new NSDictionary("Size", "L");
var product1 = new NSDictionary("SKU Code", "UHUH799",
"Product Name", "Armani Jeans",
"Price", 300.49,
"Details", detailsProduct1
);
var detailsProduct2 = new NSDictionary("Size", "L");
var product2 = new NSDictionary("SKU Code", "UHUH799",
"Product Name", "Armani Jeans",
"Price", 300.49,
"Details", detailsProduct1
);
var deliveryAddress = new NSDictionary("City", "San Francisco",
"ZIP", "94121"
);
var products = new NSMutableArray<NSDictionary>(product1, product2);
var orderPlacedAttributes = new NSDictionary("Products", products,
"Delivery Address", deliveryAddress,
"Coupons Applied", new NSMutableArray<NSString>(new NSString("BOGO17"), new NSString("BGH025"))
);
WebEngage.SharedInstance().Analytics.TrackEventWithName("Order Placed", orderPlacedAttributes);Note: WebEngage Xamarin.iOS SDK only supports the following data-types: string, NSString, NSNumber, Boolean, NSDate, NSMutableArray and NSDictionary.
-
In order to receive push notifications from WebEngage, Log in to your WebEngage dashboard and navigate to Integrations > Channels > Push, under iOS section upload your push certificate and enter your push password.
-
Now in your Xamarin.iOS app's Entitlements.plist check Enable Push Notifications.
-
Add remote-notifications as type string under App Background Modes in your app's info.plist.
-
Set autoregister to true while initialising WebEngage SDK as shown below.
...
using WebEngageXamariniOS;
namespace YourNamespace
{
...
[Register("AppDelegate")]
public class AppDelegate : UIApplicationDelegate
{
...
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
...
WebEngage.SharedInstance().Application(application, launchOptions, true);
return true;
}
...
}
...
}For detailed instructions see our documentation for integrating Push Notifications in iOS.
-
For Banner Push Notifications
-
Add a new project named
NotificationServicewith Notification Service Extension as target in your main app. -
Add WebEngageBannerPushXamariniOS.dll to References in your NotificationService project.
-
Replace
NotificationService.cswith the below code.using Foundation; using WebEngageBannerPushXamariniOS; namespace NotificationService { [Register("NotificationService")] public class NotificationService : WEXPushNotificationService { } }
-
-
For Rating and Carousel Push Notifications
-
Add a new project named
NotificationViewControllerwith Notification Content Extension as target in your main app. -
Add WebEngageAppExXamariniOS.dll to References in your NotificationViewController project.
-
Open the
Info.plistfile for NotificationViewController. Expand NSExetnsion > NSExtensionAttributes. Look for UNNotificationExtensionCategory under NSExtensionAttributes. Add it if it is not present and set the type as Array. In its items, add the following values:a.
WEG_CAROUSEL_V1for Carousel Push Notificationsb.
WEG_RATING_V1for Rating Push Notifications -
Replace
NotificationViewController.cswith the below code.using System; using Foundation; using UserNotifications; using WebEngageAppExXamariniOS; namespace NotificationViewController { public partial class NotificationViewController : WEXRichPushNotificationViewController { protected NotificationViewController(IntPtr handle) : base(handle) { } public override void ViewDidLoad() { base.ViewDidLoad(); } [Export("didReceiveNotification:")] public override void DidReceiveNotification(UNNotification notification) { base.DidReceiveNotification(notification); } } }
-
-
Set App Groups as group.[app-bundle-id].WEGNotificationGroup in
Entitlements.plistof all three projects (your Xamarin.iOS app, NotificationService and NotificationViewController).
For detailed explanation see our documentation for integrating Rich Push Notification in iOS.
In order to receive push notification callbacks, implement IWEGAppDelegate in your AppDelegate class as shown below.
...
using WebEngageXamariniOS;
namespace YourNamespace
{
[Register("AppDelegate")]
public class AppDelegate : UIApplicationDelegate, IWEGAppDelegate
{
...
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
...
WebEngage.SharedInstance().Application(application, launchOptions, true);
return true;
}
// Push notification callbacks
[Export("application:didReceiveRemoteNotification:")]
public override void ReceivedRemoteNotification(UIApplication application, NSDictionary userInfo)
{
...
}
[Export("application:didReceiveRemoteNotification:fetchCompletionHandler:")]
public override void DidReceiveRemoteNotification(UIApplication application, NSDictionary userInfo, Action<UIBackgroundFetchResult> completionHandler)
{
...
}
[Export("WEGHandleDeeplink:userData:")]
public void WEGHandleDeeplink(string deeplink, NSDictionary data)
{
...
}
// Anonymous ID callback
[Export("didReceiveAnonymousID:forReason:")]
public void DidReceiveAnonymousID(string anonymousID, WEGReason reason)
{
...
}
...
}
}No additional steps are required to receive in-app notifications.
Screens can be tracked to set rules for showing in-app notifications. For example, you can create a rule in WebEngage dashboard to show in-app notification on a particular screen.
using WebEngageXamariniOS;
...
// Simple screen
WebEngage.SharedInstance().Analytics.NavigatingToScreenWithName("Purchase Screen");
// Setting screen data
var screenData = new NSDictionary("productId", "~hs7674",
"price", 1200);
WebEngage.SharedInstance().Analytics.UpdateCurrentScreenData(screenData);- Create WebEngage in-app notification callback delegate class as shown below.
using System;
using Foundation;
using WebEngageXamariniOS;
namespace YourNamespace
{
public class InAppNotificationDelegate : WEGInAppNotificationProtocol
{
public override NSMutableDictionary NotificationPrepared(NSMutableDictionary inAppNotificationData, bool stopRendering)
{
...
return inAppNotificationData;
}
public override void NotificationShown(NSMutableDictionary inAppNotificationData)
{
...
}
public override void Notification(NSMutableDictionary inAppNotificationData, string actionId)
{
...
}
public override void NotificationDismissed(NSMutableDictionary inAppNotificationData)
{
...
}
}
}- Register the in-app notification callback delegate in your AppDelegate while initializing WebEngage SDK as shown below.
...
using WebEngageXamariniOS;
namespace YourNamespace
{
...
[Register("AppDelegate")]
public class AppDelegate : UIApplicationDelegate
{
...
private static InAppNotificationDelegate inAppNotificationDelegate;
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
...
inAppNotificationDelegate = new InAppNotificationDelegate();
WebEngage.SharedInstance().Application(application, launchOptions, inAppNotificationDelegate, true);
return true;
}
...
}
...
}Do not panic, this is a bug in iOS itself. However, rich push notifications would work fine in iOS 11 Release mode.