iOS SDK

플레어레인을 사용하여 iOS(아이폰) 앱푸시 알림을 가장 쉽게 구현할 수 있습니다. 푸시 토큰 및 구독 관리부터 딥링크 등 클릭 URL 처리까지 코드 1줄에 모든 것이 포함되어 있습니다.
타 푸시 솔루션과 함께 사용할 수 있습니다!
병행 사용을 위해서는 iOS: Swizzling 비활성화﻿ 가이드를 참고하여 몇 가지 작업을 추가해야합니다.
실제 연동이 완료된 예시를 참고하실 수 있도록 샘플 코드가 준비되어 있습니다.
1. 사전 준
비
﻿플레어레인 관리자 에서 회원가입 후 프로젝트 생성
﻿
2. 인증 값 설정
아래 가이드를 참고하여 플레어레인에 푸시 발송에 필요한 인증 값을 입력합니다.
﻿iOS: APNS 인증 정보 설정﻿﻿
﻿
3. Xcode 설정
3-1. Capability 설정
Target 의 Signing & Capabilites으로 들어와 좌상단의 + Capability > Push Notifications 를 선택하여 추가합니다.
또한 Background Modes 를 선택한 뒤 Remote notifications 를 추가합니다.
﻿
3-2. Service Extension 설정
iOS에서는 이미지 등 미디어 첨부를 위해 Notification Service Extension 생성이 필요합니다.
Xcode 에서 File > New > Target 에서 Notification Service Extension 을 선택합니다.
﻿
Product Name에 적절한 이름을 입력합니다. 본 가이드에서는 FlareLaneNotificationServiceExtension 으로 정의하겠습니다.
Language 는 가능하면 Swift 를 권장합니다.
﻿
Cancel을 클릭하여 별도의 Scheme은 활성화하지 않도록 합니다.
﻿
이후 이번에 만든 Notification Service Extension Target의 Minimum Deployments 버전을 현재 사용 중인 메인 앱 Target의 버전과 동일하게 설정합니다.
﻿
3-3. App Group 설정
본 앱과 Extension 간 데이터 동기화를 위해서는 App Group 설정이 필요합니다.
Target 의 Signing & Capabilites으로 들어와 좌상단의 + Capability > App Groups 를 선택하여 추가합니다.
group.번들ID.flarelane 이라는 이름의 그룹을 추가합니다. 나의 번들ID는 본 앱의 Bundle Identifier와 일치해야 합니다.
﻿
정상적으로 추가 후 해당 App Group을 활성화합니다.
﻿
마찬가지로 이전에 만든 Extension 에서도 동일한 이름의 App Group을 추가하고 활성화합니다.
﻿
﻿
4. SDK 연동
다음 두 가지 연동 방법 중 우리 프로젝트에 적합한 하나의 방법을 선택하여 연동합니다.
CocoaPods
 Podfile을 열고 다음과 같이 추가합니다.
Podfile
// 파일 최상단에 아래 줄을 추가하여 Dynamic Framework를 활성화합니다.
use_frameworks!

target 'YOUR_PROJECT_NAME' do
  // 아래 줄 추가
  pod 'FlareLane', '1.7.1'  
end

// 파일 최하단의 아래 줄 추가
// 앞서 입력한 Extension의 Product Name을 target 이름으로 설정합니다.
target 'FlareLaneNotificationServiceExtension' do
  pod 'FlareLane', '1.7.1'
end
// 파일 최상단에 아래 줄을 추가하여 Dynamic Framework를 활성화합니다.
use_frameworks!

target 'YOUR_PROJECT_NAME' do
  // 아래 줄 추가
  pod 'FlareLane', '1.7.1'  
end

// 파일 최하단의 아래 줄 추가
// 앞서 입력한 Extension의 Product Name을 target 이름으로 설정합니다.
target 'FlareLaneNotificationServiceExtension' do
  pod 'FlareLane', '1.7.1'
end
﻿
pod install 를 실행하여 SDK 설치를 완료합니다.
SPM (Swift Package Manager)
패키지 URL에 https://github.com/flarelane/FlareLane-iOS-SDK을 입력하고, 브랜치 1.7.1-spm을 입력합니다.
﻿
메인 타겟에는 FlareLane을, Extension 타겟에는 FlareLaneExtension 을 각각 선택합니다.
﻿
﻿
5. 초기화 코드 작성
SwiftUI vs Storyboard. 우리 프로젝트의 User Interface는 무엇인가요? 
SwiftUI 로 설정된 경우 5-1 부터
Storyboard 로 설정된 경우 5-2 부터 진행합니다.
5-1. (SwiftUI만) AppDelegate.swift 생성
SwiftUI 프로젝트는 AppDelegate.swift가 생성되어 있지 않기 때문에 먼저 파일 생성이 필요합니다.
AppDelegate.swift 파일을 새로 만들고 기존 <YOUR_PROJECT_NAME>App.swift 파일을 일부 수정합니다.
(추가)AppDelegate.swift
(기존)<YOUR_PROJECT_NAME>App.swift
import UIKit

class AppDelegate: NSObject, UIApplicationDelegate {
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    return true
  }
}

import UIKit

class AppDelegate: NSObject, UIApplicationDelegate {
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    return true
  }
}
﻿
5-2. AppDelegate 내부 연동 코드 작성 
AppDelegate 파일에 다음과 같은 초기화 코드를 입력합니다. 프로젝트 ID는 콘솔의 [프로젝트] 페이지에서 확인할 수 있습니다.
플레어레인 SDK가 제공하는 함수 리스트는  Mobile SDK Reference﻿ 에서 확인할 수 있습니다.
Switft(AppDelegate.swift)
Objective-C(AppDelegate.m)
// 1. SDK 사용을 위해 import 코드 추가
@import FlareLane;

@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

     // 2. 아래 init 코드 추가
     // 알림 권한 팝업 타이밍을 제어하려면 세 번째 파라미터를 false로 설정 후 적절한 시점에 .subscribe() 함수 실행
     [FlareLane initWithLaunchOptions:launchOptions projectId:@"PROJECT_ID" requestPermissionOnLaunch:true];
}
// 1. SDK 사용을 위해 import 코드 추가
@import FlareLane;

@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

     // 2. 아래 init 코드 추가
     // 알림 권한 팝업 타이밍을 제어하려면 세 번째 파라미터를 false로 설정 후 적절한 시점에 .subscribe() 함수 실행
     [FlareLane initWithLaunchOptions:launchOptions projectId:@"PROJECT_ID" requestPermissionOnLaunch:true];
}
﻿
5-3. Extension 초기화 코드 작성
앞서 생성한 Extension 파일을 수정합니다. 자동으로 채워진 코드들을 지우고 플레어레인이 제공하는 클래스를 상속하기만 하면 됩니다.
Swift(NorificationService.swift)
Objective-C(NotificationService.h/.m)

// NotificationService.h
@import FlareLane;

@interface NotificationService : FLNNotificationServiceExtension
@end

// NotificationService.m
#import "NotificationService.h"

@implementation NotificationService
@end


// NotificationService.h
@import FlareLane;

@interface NotificationService : FLNNotificationServiceExtension
@end

// NotificationService.m
#import "NotificationService.h"

@implementation NotificationService
@end
﻿
﻿
6. 테스트
여기까지 모두 완료하셨으면 앱 빌드, 실행 시 자동으로 플레어레인 전체 기기 리스트에 추가됩니다.
실제 배포 전, 푸시를 실제 발송하여 기기에 잘 오는지, 푸시 클릭 시 통계에 잘 잡히는지 반드시 직접 확인하시기 바랍니다.
FCM 등 푸시 솔루션을 병행 사용하고 있는 경우 iOS: Swizzling 비활성화﻿를 참고하여 몇 가지 작업을 추가해야합니다.
﻿
7. (선택) 웹뷰 기반 앱 추가 연동
한국에서는 웹뷰 기반 앱이 운영되는 경우가 많으며 플레어레인은 그러한 특성을 반영하여 웹뷰 기반 앱을 위한 다양한 편의 기능을 제공하고 있습니다.
﻿웹뷰 기반 모바일 앱 브릿지 연동﻿ 가이드를 참고하여 웹사이트에서 일어나는 행동을 앱에서도 인식할 수 있도록 합니다.
﻿
8. 유저ID 연동
앱 설치 시 플레어레인에 생성된 기기는 '익명의 기기'이며 고객사가 별도로 관리하는 고유한 유저 ID﻿를 연동함으로써 플레어레인의 기기와 고객사의 유저ID를 매칭할 수 있습니다.
유저ID가 연동되어있으면 많은 이점이 있습니다. 회원과 비회원을 구분할 수 있고, 고객사는 언제든지 유저ID를 기준으로 푸시 알림 발송이 가능하기 때문에 초기 연동시 권장드리고 있습니다.
보통 유저가 회원가입이나 로그인 성공 시, setUserId 함수를 통해 유저ID를 연동합니다.
웹뷰 기반 앱인 경우 로그인은 웹사이트에서 일어나므로 브릿지 연동이 되어있다면 Web SDK에서 setUserId를 호출하여도 무방합니다.
Swift
ObjectiveC
FlareLane.setUserId(userId: "USER_ID")
FlareLane.setUserId(userId: "USER_ID")
﻿
﻿
(심화) 추가 연동
자동 URL 처리
플레어레인은 기본적으로 푸시 알림 클릭 시 https, 딥링크 등 URL에 대해 자동 처리를 지원하고 있습니다. 만약 별도의 클릭 핸들러 구현이 필요한 경우 URL 자동 처리 비활성화﻿를 참고하세요.
﻿
기타 리소스
가이드
﻿Mobile SDK Reference﻿﻿
﻿iOS SDK Release Notes﻿﻿
﻿