Swift SDK Integration

This SDK is developed using the Swift programming language. We provide integration support with Swift Package Manager (SPM). You can take advantage of Swift's expressive and intuitive nature, enabling you to create sophisticated applications with ease. 🎉 We strongly recommend incorporating Swift SDK integration for incorporating Netmera into your new projects.

Quick Steps Guidelines

Step 1: Create an Apple Push Notification Certificate

Obtain your Apple Push Notification Certificate from developer.apple.com and add it to your Netmera panel on Developer > Push Backend.

Step 2: Integrate SDK into Your Project

Add Netmera to your Podfile and run pod install command in your terminal.

Step 3: Setup Netmera

Import the Netmera framework in your AppDelegate.swift file and initialize Netmera in your app.

Step 4: Request Push Notification Authorization

In your pod file, add NetmeraNotification and request push notification authorization from user.

Step 5: Configure your Xcode Settings for Enabling Push Notifications

Enable push notifications for your app by navigating to Signing & Capabilities > Capability > Push Notifications on Xcode.

Swift SDK integration completed 👏

Onboarding Checklist: Swift and Flutter

Please find the Onboarding Checklist for Swift and Flutter below. Follow the titles in the checklist to ensure you have completed each essential step in your onboarding process with Netmera.

44KB

Netmera Mobile Technical Onboarding Checklist (Swift & Flutter).xlsx

Step 1: Create an Apple Push Notification Certificate

We send push notifications using APNS (Apple Push Notification Service). Therefore, you need to obtain an Apple Push Notification Certificate from www.developer.apple.com using your account. Once you have the certificate, you should export it using Keychain Access and add it to the iOS page in the panel's left menu under Developer > Push Backend.

Important Notes on Bundle ID:

Make sure to add the certificate generated with the bundle ID of your project to the panel, and set the bundle ID of your project in the panel as well. The bundle ID of your project, the bundle ID of the certificate, and the bundle ID set in the panel should all match.

In case of having problems sending push notifications when you build from Xcode:

Check the certificate type on the Developer > Backend Transfer > iOS page in the menu on the left. If you downloaded the app from the store or are testing it via TestFlight, the certificate type must be "prod". If you are compiling from Xcode, the certificate type must be selected as "dev".

Step 2: Integrate SDK into Your Project

Requirements:

• Xcode 13 or later

• iOS 11.0 or later

When integrating the SDK into your project, you have two primary options: using Cocoapods or Swift Package Manager (SPM). Below are the steps for each method:

Integrating by using Cocoapods - Option 1

To integrate Netmera SDK into your project using Cocoapods, follow these steps:

1. Open your project's Podfile and add the following lines to integrate Netmera features you need:

pod "NetmeraAnalytic" // to use Netmera analytic features
pod "NetmeraAnalyticAutotracking" // to use auto tracking features
pod "NetmeraNotification" // to use Netmera push notification features
pod "NetmeraAdvertisingId" // to use Netmera advertising identifier features
pod "NetmeraLocation" // to use Netmera location features
pod "NetmeraGeofence" // to use Netmera geofence features
pod "NetmeraNotificationInbox" // to use Netmera push inbox features

1. Run pod install command in your terminal.

Integrating by using SPM - Option 2

To integrate Netmera SDK into your project using SPM, follow these steps:

1. Go to Project Settings > Package Dependencies and click the "+" button.

1. On the top right-hand side, enter the following link in the search bar: https://github.com/Netmera/swift-sdk and the package details will be automatically retrieved.

2. Lastly, click on "Add Package".

Step 3: Setup Netmera

1. Import the Netmera framework in your AppDelegate.swift file.

Note: When you create new projects based on SwiftUI in Xcode, the AppDelegate.swift file is not included by default. Instead, SwiftUI applications use an App struct marked with @main to manage the application lifecycle. This structure takes over the responsibilities traditionally handled by the AppDelegate.

import NetmeraAnalytic
import NetmeraNotification
import NetmeraLocation
import NetmeraNotificationInbox
import NetmeraAdvertisingId

1. Initialize Netmera in your App. There are two ways to initialize Netmera.

Configuring with Netmera Plist

1. Add Netmera-Config.plist file to your project. Copy the following code into the Plist file and replacing the API_KEY placeholders with your actual API Key value.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>sdk_params</key>
    <dict>
        <key>app_group_name</key>
        <string>{AppGroupName}</string>
        <key>use_ui_scene</key>
        <false/>
        <key>api_key</key>
        <string>{API_KEY}</string>
        <key>custom_events</key>
        <array>
            <string>{YourCustomEvent}</string>
        </array>
    </dict>
    <key>location_max_active_region</key>
    <string></string>
    <key>in_app_message_settings</key>
    <dict>
        <key>TextColor</key>
        <string>{hexcolor. For ex-&gt; 16777215}</string>
        <key>TitleColor</key>
        <string>{hexcolor. For ex-&gt; 16777215}</string>
        <key>BackgroundColor</key>
        <string>{hexcolor. For ex-&gt; 16777215}</string>
        <key>CancelButtonBackgroundColor</key>
        <string>{hexcolor. For ex-&gt; 16777215}</string>
        <key>TitleFont</key>
        <string>{font family name. ex -&gt; ariel}</string>
        <key>TextFont</key>
        <string>{font family name. ex -&gt; ariel}</string>
        <key>CancelButtonRadius</key>
        <string>{10 sd px}</string>
        <key>ShadowOpacity</key>
        <string>{0-1}</string>
        <key>BottomPaddingRatio</key>
        <string>{between 0.01 - 1}</string>
        <key>CancelButtonImage</key>
        <string>{imagename}</string>
    </dict>
    <key>blacklist_screen_names</key>
    <array/>
</dict>
</plist>

1. Call Netmera initialize method in your application(_:didFinishLaunchingWithOptions:) method.

Netmera.initialize()
Netmera.setLogLevel(.debug) // Options can be .debug, .info, .error, .fault
// In order to see Netmera logs add setLogLevel in .debug mode

Only For On-Premises Customers: After adding your API key, include the following lines of code:

<key>base_url</key>
<string>{BaseURL}</string>

This ensures the correct configuration for your on-premises environment.

Please make sure you get the API key value from the relevant panel:

YOUR_SDK_API_KEY: You can get that api key from Developers -> API -> SDK API Key from your web panel.

Step 4: Request Push Notification Authorization

In your pod file, you should add NetmeraNotification and install to your app target like the following.

pod "NetmeraNotification"

Request push notification authorization from user by calling the following method in an appropriate place.

Netmera.requestPushNotificationAuthorization(for: [.alert, .badge, .sound])

Essential to Inform the User:

When calling this method, it will promptly trigger the push notification permission dialog for the user. Therefore, it's essential to invoke this method after informing the user about how your application will utilize push notifications.

Important Note:

If you receive a push permission request from a push provider like Apple, it's crucial to call the appropriate method. This ensures that the Netmera SDK can correctly handle interactive push notification buttons. Failing to do so may result in these buttons not being properly managed by the SDK.

Step 5: Enable Push Notifications

Enable push notifications for your app by navigating to,

Signing & Capabilities > Capability > Push Notifications in Xcode.

UNUserNotificationCenterDelegate methods should be added in AppDelegate:

//in didFinishLaunchingWithOptions
//Implement UNUserNotificationCenterDelegate methods in AppDelegate
UNUserNotificationCenter.current().delegate = self

func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
	//
}
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
	//
}

Configuring Multiple Environments

Here are the steps for configuring multiple environments, such as test and production, in your Xcode project:

Step 1:

Copy the Netmera-Config.plist corresponding to your Netmera development environment into the Dev directory. Similarly, copy the Netmera-Config.plist corresponding to your Netmera production environment into the Prod directory. Make sure to uncheck “Copy items if needed” and ensure that no targets are selected under “Add to targets.”

Step 2:

In the Xcode project navigator, select your app target. Switch to the Build Phases tab, and add a New Run Script Phase. Name this phase something like “Setup Netmera Environment Netmera-Config.plist,” and place it before the Copy Bundle Resources step.

Step 3:

Implement a shell script that will copy the correct Netmera-Config.plist into the app bundle based on the current build configuration. Use the following script in the Run Script Phase:

bashCopy code# Name of the resource we're selectively copying
NETMERA_CONFIG_PLIST=Netmera-Config.plist

# Get references to dev and prod versions of the Netmera-Config.plist
# NOTE: These should only live on the file system and should NOT be part of the target (since we'll be adding them to the target manually)
NETMERA_CONFIG_DEV=${PROJECT_DIR}/${TARGET_NAME}/NetmeraConfig/Dev/${NETMERA_CONFIG_PLIST}
NETMERA_CONFIG_PROD=${PROJECT_DIR}/${TARGET_NAME}/NetmeraConfig/Prod/${NETMERA_CONFIG_PLIST}

# Make sure the dev version of Netmera-Config.plist exists
echo "Looking for ${NETMERA_CONFIG_PLIST} in ${NETMERA_CONFIG_DEV}"
if [ ! -f $NETMERA_CONFIG_DEV ]
then
    echo "No Development Netmera-Config.plist found. Please ensure it's in the proper directory."
    exit 1
fi

# Make sure the prod version of Netmera-Config.plist exists
echo "Looking for ${NETMERA_CONFIG_PLIST} in ${NETMERA_CONFIG_PROD}"
if [ ! -f $NETMERA_CONFIG_PROD ]
then
    echo "No Production Netmera-Config.plist found. Please ensure it's in the proper directory."
    exit 1
fi

# Get a reference to the destination location for the Netmera-Config.plist
PLIST_DESTINATION=${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.app
echo "Will copy ${NETMERA_CONFIG_PLIST} to final destination: ${PLIST_DESTINATION}"

# Copy over the prod Netmera-Config.plist for Release builds
if [ "${CONFIGURATION}" == "Release" ]
then
    echo "Using ${NETMERA_CONFIG_PROD}"
    cp "${NETMERA_CONFIG_PROD}" "${PLIST_DESTINATION}"
else
    echo "Using ${NETMERA_CONFIG_DEV}"
    cp "${NETMERA_CONFIG_DEV}" "${PLIST_DESTINATION}"
fi

This script checks whether the development and production versions of Netmera-Config.plist exist in their respective directories, then copies the appropriate one to the app bundle based on the build configuration (Debug or Release).

Swift SDK integration completed 👍

Swift SDK integration has been successfully completed, and your devices are now ready to receive the following types of push notifications sent via the Netmera Dashboard:

1. Standard Push Notifications

2. Interactive Push Notifications (If you've configured and published them using the Dashboard)

3. Push Notifications with Web View Content

4. Push Notifications with Deeplinks