iOS SDK Setup
1. Requirements
Can be used with other push solutions!
To use FlareLane with other push solutions, you must follow some additional steps. Refer to iOS: Disable Swizzling for details.
Sign up to FlareLane and create a project
2. Credentials Setup
Follow this guide below:
3. Xcode Setup
Go to Signing & Capabilities
and click + Capability
and add Push Notifications

In Xcode, select Notification Service Extension
from File > New > Target

Enter the Product Name. In this guide, we will define it as FlareLaneNotificationServiceExtension
.

Set Minimum Deployments
of the Notification Service Extension Target you just created to be the same as the main app target you are currently using.

4. Install SDK using CocoaPods
Add the following code to your Podfile
// Enable the Dynamic Framework
use_frameworks!
target 'YOUR_PROJECT_NAME' do
// Add the code below
pod 'FlareLane', '1.7.4'
end
// Add the name of the extension created previously.
// In this guide, FlareLaneNotificationServiceExtension.
target 'FlareLaneNotificationServiceExtension' do
pod 'FlareLane', '1.7.4'
end
Run pod install
in the terminal
5. Initialization
(5-1. SwiftUI Only)
Since AppDelegate.swift is not created in the SwiftUI project, the file needs to be created first.
Create a new AppDelegate.swift file and add some code to <YOUR_PROJECT_NAME>App.swift file.
struct <YOUR_PROJECT_NAME>App: App {
// Add the code below
@UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
}
5-2. AppDelegate
import FlareLane
class AppDelegate: UIResponder, UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Add the code below
// To subscribe later, set the 3rd parameter to false and then run .subscribe() later.
FlareLane.initWithLaunchOptions(launchOptions, projectId: "<INPUT_YOUR_PROJECT_ID>", requestPermissionOnLaunch: true)
return true
}
}
5-3. Notification Service Extension
Run Xcode again and edit the extension's file. Delete the pre-filled codes and only inherit FlareLaneNotificationServiceExtension
.
import FlareLane
class NotificationService: FlareLaneNotificationServiceExtension {
}
6. Test
After completing all the steps, build and run your app. Devices that subscribe to push notifications will be automatically added to FlareLane console's All Devices.
Before actual deployment, be sure to verify that the push notifications are being received properly on the device and that the statistics are accurately recorded when the push notifications are clicked.
7. Identify your user
FlareLane's device is 'anonymous' and you can match the device with your user based on the unique user ID that identifies your user.
Usually, when a user sign-up or log-in, you should execute setUserId
.
FlareLane.setUserId(userId: "USER_ID")
8. Additional Setup
To use Journeys or Message Personalization, integrate custom data via SDK or API:
Resources
Last updated