Plumb5 SDK for iOS Devices

The document details steps required to integrate Plumb5 SDK into your application for iOS devices. For any questions or queries please email us at support@plumb5.com

Getting Started

Before you can begin working with Plumb5SDK on iOS, you need to download the Plumb5 SDK for iOS and ensure that you have an APP key and Service URl.

Please login to Plumb5 and Download the SDK.

Step1 : Get the latest version of Xcode

To build a project using Plumb5 SDK for iOS, you need Xcode 8 or above version

Step2: Obtain the APP Key and Service URL

Register with www.plumb5.com to obtain your APP Key and Service URL. If you have been provided with an APP key and Service URL, you can use that instead. Please write to support@plumb5.com for any help.

Step3: Provide your application details.

Provide your application’s APNs Certificate, Passphrase and application Bundle Identifier/Package Name from your account (Service Gateway Configuration -> Push Settings).

Step 4: Integrate SDK into Project

Follow below given points

  • Download “Plumb5SDK.framework”
  • Unpack the source files.
  • Launch Xcode and either open an existing project, or create a new project. If you're new to iOS, create a Single View Application, and disable Use Storyboards and enable Use Automatic Reference Counting.
  • Drag and drop the “Plumb5SDK.framework” in to your xcode project, When prompted, ensure Copy items into destination group's folder is selected.
  • Now Select the project file.
  • Add Plumb5SDK.framework under Embedded Binaries.
  • Select your project from the Project Navigator, and choose your Deployment target
  • Open the Build Phases tab, and within Link Binary with Libraries, add the following frameworks: Plumb5SDK.framework
  • Select Target, go to general and add Plumb5SDK.framework into embedded binaries

Step 5: Your project shall have podfile, if you don’t have go to the following url to setup the pod project

If you don't already have the CocoaPods tool, install it on macOS by running the following command from the terminal. For details, see the : www.guides.cocoapods.org/using/getting-started.html

Execute the following command on the terminal in project directory

  • cd <Space> Project Directory and hit enter.
  • Pod <Space> init
  • Now go to the project folder.
  • Find the pod file under the created project
  • Add the following lines into your podfile above of target ‘Your project Name’ do
    • pod 'Alamofire', '~> 4.2.0'
    • pod 'ReachabilitySwift'
    • pod 'SugarRecord/CoreData'
    • pod 'SugarRecord/CoreData+iCloud'
  • Save the pod file.

Open a terminal and go to the directory containing the pod file cd < Project Path >

Execute the “Pod install” command. This will install the APIs specified in the podfile, along with any dependencies they may have  $ pod install

Step 6: Add the following lines in your info.plist file

<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>

<string>Description</string>

<key>NSLocationAlwaysUsageDescription</key>

<string>App needs Location</string>

<key>NSLocationWhenInUseUsageDescription</key>

<string>App needs Location</string>

<key>NSAppTransportSecurity</key>

<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>

It will prompt the user requesting permission to access current location.

Step 7: AppDelegate Configuration

Do the following steps in to your appdelegate file

1. Import those libraries top of your appdelegate file
  • import Plumb5SDK
  • import UserNotifications
  • import CoreLocation
2. Add below code above your AppDelegate class (or above @UIApplicationMain )

@available(iOS 10.0, *)

3. Declare location manager inside your AppDelegate class.

let locationManager = CLLocationManager()

4. Write below code snippet in Application didFinishLaunchingWithOptions method and provide your app key above return true statement

let appKey = “ provide your app key ”
let serviceUrl = “(your service url)”
locationManager.delegate = self
locationManager.requestAlwaysAuthorization()
registerForPushNotifications()
P5SDKManager.initP5SDK(key: appKey , serviceURL = serviceUrl)
P5SDKManager.sharedInstance.delegate = self;
P5SDKManager.applicationLaunchedWithOption(launchOptions: launchOptions)

5. Add the below methods in AppDelagate class.

func registerForPushNotifications() {
if #available(iOS 10, *) {
UNUserNotificationCenter.current().requestAuthorization(options: [.alert, .sound,
.badge]) {
(granted, error) in
print("Permission granted: \(granted)")
guard granted else { return }
self.getNotificationSettings()
} }else if #available(iOS 9, *) {
UIApplication.shared.registerUserNotificationSettings(UIUserNotificationSettings(types:
[.badge, .sound, .alert], categories: nil))
UIApplication.shared.registerForRemoteNotifications()
} }

func getNotificationSettings() {
UNUserNotificationCenter.current().getNotificationSettings { (settings) in
print("Notification settings: \(settings)")
guard settings.authorizationStatus == .authorized else { return }
UIApplication.shared.registerForRemoteNotifications()
} }

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
let tokenParts = deviceToken.map { data -> String in
return String(format: "%02.2hhx", data)
}
let token = tokenParts.joined()
print("Device Token: \(token)")
P5SDKManager.sharedInstance.p5DeviceToken = token;
}

func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
print("Failed to register: \(error)")
}

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any],
fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult)

-> Void) {
print(userInfo);
P5SDKManager.handlePushNotification(userInfo: userInfo)
}

func application(_ application: UIApplication, didReceive notification: UILocalNotification)
{
P5SDKManager.handleLocalNotification(notification: notification)
}

6. Add Extension in Appdelegate.swift

@available(iOS 10.0, *)
extension AppDelegate: CLLocationManagerDelegate, P5ActionsDelegate {
func locationManager(_ manager: CLLocationManager, didEnterRegion region: CLRegion)
{
P5SDKManager.handleGeofenceEvent(region: region, onEntry: "1")
}
func locationManager(_ manager: CLLocationManager, didExitRegion region: CLRegion) {
P5SDKManager.handleGeofenceEvent(region: region, onEntry: "2")
}
func handleActionWithType(type : Actions, userInfo : Dictionary<String, Any>){
// Here you can write your redirect screen function for In-App dialog,Banner and Push
Notification button action or any others functions you want with the userInfo response.
}
}

Step 8: Register Users

It is required to pass the following user information to uniquely identify the user. The user information is tagged against the device id, enabling real time analytics and engagement.

P5SDKManager.registerUser(name: "name", email: "userid@gmail.com", phoneNumber:"987654321", extraParam: "extra")

Step 9: Show In-App Banner

To show In-App Banner get a uiview on your viewcontroller in Main.storyboard in which viewcontroller you want to show.

Banner view is instance of UIView. You can manage its position where ever you want can show with whatever size you want.

Then call below method with your parameter including your UIView in your viewcontroller class.

P5SDKManager.loadBanner(screenName : String, bannerView: UIView, delegate : P5BannerDelegate)

Then set or extend “ P5BannerDelegate ” to get the following callback methods.

func bannerLoaded() // Called when banner is loaded
func bannerRemoved() //called when banner is removed or close button is clicked. Please do implement both.

Step 10: Get Event Data

To get your event data call this below method with your parameter value inside your button action or event.

P5SDKManager.trackEvents(name: "Show banner", type: P5SDKManager.BUTTON_CLICK,value: "100")

Step 11: Implement Push Notification

  • Go to “Capabilities” option in your project setting then set ON to Push Notification and Background Modes and check Remote notifications inside Background Modes.
  • Set up extension:
  • The process of adding a notification service extension to an iOS app is identical to that of other extensions. In the Xcode menu bar, go to File > New > Target... and select the Notification Service Extension template from the menu that appears.

  • Copy and paste content of NotificationService.swift from sample app in your extensions NotificationService.swift file.
  • Set Allow Arbitrary Loads to Yes in Info.plist of your extension. It is based on your requirement.
Top