If you are using a version lower than 2.0.0 go here.
In this page:
Step 1 - Requirements
iOS Mobile App & Xcode |
---|
P12 file & password. Click here to create a P12 file. |
AppAlias (You can get it from RMC Panel) If you do not have an account, our sales representatives will contact you. Click here. |
Step 2 - Installation
2.1 Euromsg is available through CocoaPods. To install it, simply add the following line to your Podfile
pod 'Euromsg', '>= 2.0.0'
Step 3 - Add Application to RMC Panel
First, create your application from the RMC Panel. App Alias section should be unique to you. RMC makes the distinction based on this value.
Step 4 - Usage
Add a Notification Service Extension
NotificationServiceExtension allows your iOS application to receive rich notifications with images, buttons, and badges. It's also required for Euromessage's analytics features.
In Xcode File > New > Target...
Select Notification Service Extension then press Next.
Enter the product name as NotificationService and press Finish.
Do not select Activate on the dialog that is shown after selecting Finish.
By canceling, you are keeping Xcode debugging your app, instead of the extension you just created.
If you activated by accident, you can switch back to debug your app within Xcode (next to the play button).
In the project navigator, select the top-level project directory and select the NotificationSerivce target in the project and targets list. Unless you have a specific reason not to, you should set the Deployment Target to be iOS 11.
Open NotificationService.swift and replace the whole file's contents with the following code.
import UserNotifications import Euromsg class NotificationService: UNNotificationServiceExtension { var contentHandler: ((UNNotificationContent) -> Void)? var bestAttemptContent: UNMutableNotificationContent? override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) { self.contentHandler = contentHandler bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent) Euromsg.didReceive(bestAttemptContent, withContentHandler: contentHandler) } override func serviceExtensionTimeWillExpire() { // Called just before the extension will be terminated by the system. // Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used. if let contentHandler = contentHandler, let bestAttemptContent = bestAttemptContent { Euromsg.didReceive(bestAttemptContent, withContentHandler: contentHandler) } } }
Add a Notification Content Extension
Note: If you are going to use carousel push sending, you need to add this.
In Xcode File > New > Target...
Select Notification Content Extension then press Next.
Enter the product name as NotificationContent and press Finish.
Do not select Activate on the dialog that is shown after selecting Finish.
By canceling, you are keeping Xcode debugging your app, instead of the extension you just created.
If you activated by accident, you can switch back to debug your app within Xcode (next to the play button).
In the project navigator, select the top-level project directory and select the NotificationContent target in the project and targets list. Unless you have a specific reason not to, you should set the Deployment Target to be iOS 11.
Delete MainInterface.storyboard and NotificationContent.swift files. Then create a swift file named EMNotificationViewController under the NotificationContent folder. Make sure the info.plist file is the same as in this link.
Don't Create Objective-C Bridging Header
Open EMNotificationViewController.swift and replace the whole file's contents with the following code
import UIKit import UserNotifications import UserNotificationsUI import Euromsg @available(iOS 10.0, *) @objc(EMNotificationViewController) class EMNotificationViewController: UIViewController, UNNotificationContentExtension { let appUrl = URL(string: "euromsgExample://") let carouselView = EMNotificationCarousel.initView() var completion: ((_ url: URL?, _ userInfo: [AnyHashable: Any]?) -> Void)? func didReceive(_ notification: UNNotification) { carouselView.didReceive(notification) } func didReceive(_ response: UNNotificationResponse, completionHandler completion: @escaping (UNNotificationContentExtensionResponseOption) -> Void) { carouselView.didReceive(response, completionHandler: completion) } override func loadView() { completion = { [weak self] url, userInfo in if let url = url { self?.extensionContext?.open(url) if url.scheme != self?.appUrl?.scheme, let userInfo = userInfo { Euromsg.handlePush(pushDictionary: userInfo) } } else if let url = self?.appUrl { self?.extensionContext?.open(url) } } carouselView.completion = completion self.view = carouselView } }
The podfile file should be as follows. Then go to the project path through the terminal, type pod install and press enter.
AppDelegate.swift
Firstly import Euromsg and UserNotifications
import Euromsg import UserNotifications
Add UNUserNotificationCenterDelegate to the class AppDelegate section.
class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate
Add this code under didFinishLaunchingWithOptions.
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { UNUserNotificationCenter.current().delegate = self Euromsg.configure(appAlias: "YOUR_APP_ALIAS", enableLog: true) Euromsg.registerForPushNotifications() Euromsg.askForNotificationPermission() if #available(iOS 13, *) { // handle push for iOS 13 and later in sceneDelegate } else if let userInfo = launchOptions?[UIApplication.LaunchOptionsKey.remoteNotification] as? [String: Any] { Euromsg.handlePush(pushDictionary: userInfo) } return true }
User has to accept to receive push messages. If the user accepts and the device is successfully registered to the APNS, the following method is called in AppDelegate
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { Euromsg.registerToken(tokenData: deviceToken) }
In order for push reports to be reflected on RMC, you need to add the following functions.
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any]) { Euromsg.handlePush(pushDictionary: userInfo) } func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) { Euromsg.handlePush(pushDictionary: userInfo) } func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) { completionHandler([.alert, .badge, .sound]) } func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) { Euromsg.handlePush(pushDictionary: response.notification.request.content.userInfo) completionHandler() }
SceneDelegate.swift
func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) { // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`. // If using a storyboard, the `window` property will automatically be initialized and attached to the scene. // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead). guard let _ = (scene as? UIWindowScene) else { return } if #available(iOS 13, *), let userInfo = connectionOptions.notificationResponse?.notification.request.content.userInfo { Euromsg.handlePush(pushDictionary: userInfo) } }
Send Information to RMC
Run the code below when the user successfully logs in, registers and the first time the application is opened.
In order for your data from the mobile channel to be uploaded to RMC, please pay attention that whatever reference value you have used in your active RMC account (KEY_ID * or E-Mail) comes from the mobile channel with this reference.
*KEY_ID: These are the id values used by the application owner to deduplicate the customer. These can be expressed with different names such as CRMid, userid, customerid, accountid.
Euromsg.setEmail(email: "test@relateddigital.com", permission: true) Euromsg.setEuroUserId(userKey: "1234567890") Euromsg.sync()
IYS Email Register
Add it just before Euromsg.sync() code.
Euromsg.registerEmail(email: "example@email.com", permission: true) //You can also call TACIR account as following Euromsg.registerEmail(email: "example@commercial.com, permission: true, isCommercial: true)
Optional Parameters
setUserProperty: User to fill demographic fields
setAppVersion: You can segment according to the version your users use.
checkConfiguration: You can check the permission status of users
setPushNotification, setEmail, setPhoneNumber: You can set the permission status of users.
Euromsg.setUserProperty(key: "Key", value: "Value") Euromsg.setAppVersion(appVersion: "1.0.0") let conf = Euromsg.checkConfiguration() conf.properties?.pushPermit conf.properties?.emailPermit conf.properties?.gsmPermit Euromsg.setPushNotification(permission: true) Euromsg.setEmail(permission: true) Euromsg.setPhoneNumber(permission: true)
Reflection of Push Campaign Revenues to RMC Panel
After clicking the incoming push notification, you need to use the following method to reflect the purchase made in the Revenue field in the RMC panel.
You must enter utm parameters in the Custom Parameters field on the push screen.
Ex: utm_medium=apppush;utm_source=related;utm_campaign=campaign_name
P.S: Since utm_campaign should be different each time, you can use the ID of the push campaign you created as a variable. You can optionally use the <## CAMP_ID ##> variable for this.After clicking the push notification, a data will be returned to you as below.
Sample Data:
"pushId": df73706e-1138-40f2-b687-c10c43ee8138, "aps": { alert = { body = Test; title = Test; }; badge = 0; "content-available" = 0; "mutable-content" = 1; sound = ""; }, "pushType": Text, "url": , "mediaUrl": , "deepLink": , "altUrl": , "utm_campaign": campaign_name, "utm_medium": apppush, "utm_source": related
You should handle this data just like using deeplink and send the utm parameters as event to Visilabs when the push message is clicked. You can find sample Visilabs event codes on the bottom line.
Objective-C
NSMutableDictionary *properties = [[NSMutableDictionary alloc] init]; [properties setObject:@"utm_campaign" forKey:@"campaign_name"]; [properties setObject:@"utm_source" forKey:@"related"]; [properties setObject:@"utm_medium" forKey:@"apppush"]; [properties setObject:@"KeyID or Email" forKey:@"OM.exVisitorID"]; //Your reference in the RMC system [properties setObject:@"User Token for Push Message" forKey:@"OM.sys.TokenID"]; [properties setObject:@"AppAlias" forKey:@"OM.sys.AppID"]; [[Visilabs callAPI] customEvent:@"Campaign" withProperties:properties];
Swiftvar properties = [String:String]() properties["utm_campaign"] = "campaign_name" properties["utm_source"] = "related" properties["utm_medium"] = "apppush" properties["OM.exVisitorID "] = "KeyID or Email" //Your reference in the RMC system properties["OM.sys.TokenID"] = "User Token for Push Message" properties["OM.sys.AppID"] = "AppAlias" Visilabs.callAPI().customEvent("Campaign", withProperties: NSMutableDictionary(dictionary: p