> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Ionic/Cordova/Capacitor SDK 설정
> iOS, Android, Amazon Fire 앱을 위한 Ionic 또는 Capacitor 앱에 OneSignal SDK를 추가하는 방법
export const SdkReleasesIframe = ({sdkFilter = undefined, viewMode = undefined, height, ...frameProps}) => {
const baseUrl = 'https://onesignal.github.io/sdk-releases';
const buildUrl = (theme, sdkFilter, viewMode) => {
const url = new URL(baseUrl);
const params = new URLSearchParams();
if (theme) {
params.set('theme', theme);
}
if (sdkFilter) {
params.set('sdk', sdkFilter);
}
if (viewMode) {
params.set('viewMode', viewMode);
}
if (params.toString()) {
url.search = params.toString();
}
return url.toString();
};
const detectTheme = () => {
if (document.documentElement.classList.contains('dark')) {
return 'dark';
}
return 'light';
};
const [theme, setTheme] = useState('light');
const [iframeSrc, setIframeSrc] = useState(() => {
const initialTheme = detectTheme();
return buildUrl(initialTheme, sdkFilter, viewMode);
});
useEffect(() => {
const currentTheme = detectTheme();
setTheme(currentTheme);
setIframeSrc(buildUrl(currentTheme, sdkFilter, viewMode));
const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
const handleThemeChange = () => {
const newTheme = detectTheme();
setTheme(newTheme);
setIframeSrc(buildUrl(newTheme, sdkFilter, viewMode));
};
if (mediaQuery.addEventListener) {
mediaQuery.addEventListener('change', handleThemeChange);
} else {
mediaQuery.addListener(handleThemeChange);
}
window.addEventListener('storage', handleThemeChange);
const observer = new MutationObserver(handleThemeChange);
observer.observe(document.documentElement, {
attributes: true,
attributeFilter: ['class', 'data-theme']
});
return () => {
if (mediaQuery.removeEventListener) {
mediaQuery.removeEventListener('change', handleThemeChange);
} else {
mediaQuery.removeListener(handleThemeChange);
}
window.removeEventListener('storage', handleThemeChange);
observer.disconnect();
};
}, [sdkFilter, viewMode]);
const getIframeHeight = () => {
if (viewMode === 'table') {
return '450';
}
if (viewMode === 'mini') {
return '170';
}
return '800';
};
const iframeHeight = height || getIframeHeight();
return
;
};
## 개요
이 가이드는 Ionic, Capacitor 또는 Cordova 애플리케이션에 OneSignal 푸시 알림을 통합하는 방법을 설명합니다. 설치부터 구성 및 서비스 워커 관리까지 모든 것을 다룹니다.
Capacitor 앱을 개발 중인가요? 대신 [Capacitor SDK 설정](./capacitor-sdk-setup) 가이드를 사용하는 것을 강력히 권장합니다. 기존 Cordova 코드와의 호환성을 위해 Capacitor 프로젝트에서 Cordova 플러그인을 반드시 사용해야 하는 경우에만 이 Cordova 설정을 사용하세요.
***
## 요구 사항
* Cordova v10+ (설정 지침은 v12 사용)
* 구성된 OneSignal 앱 및 플랫폼
* Ionic v7+ (설정 지침은 v7.2.1 사용)
* Capacitor v5+ (설정 지침은 v7.2.0 사용)
* 구성된 OneSignal 앱 및 플랫폼
**iOS 요구 사항**
* cordova-ios 8.0+
* Xcode 14+가 설치된 macOS (설정 지침은 Xcode 16.2 사용)
* iOS 12+, iPadOS 12+가 설치된 기기 또는 iOS 16.2+ 실행하는 Xcode 시뮬레이터
* CocoaPods 1.16.2+
**Android 요구 사항**
* Google Play 스토어(서비스)가 설치된 Android 7.0+ 기기 또는 에뮬레이터
앱 이름에 공백이 포함되어서는 안 됩니다(예: 빌드 문제를 방지하기 위해 "My App" 대신 "MyApp")
### OneSignal 앱 및 플랫폼 구성
지원하는 플랫폼(Apple (APNs), Google (FCM), Huawei (HMS), Amazon (ADM))으로 OneSignal 앱을 구성하세요.
조직에 이미 OneSignal 계정이 있는 경우 조직에 [초대를 요청](/docs/ko/manage-team-members)하세요. 그렇지 않은 경우 [무료 계정에 가입](https://onesignal.com)하여 시작하세요.
**New App/Website**를 클릭하여 새 앱을 만들거나 **설정 > 푸시 및 인앱**에서 기존 앱에 플랫폼을 추가합니다. 구성하려는 플랫폼을 선택하고 **Next: Configure Your Platform**을 클릭합니다.
플랫폼에 대한 자격 증명을 입력합니다:
* **Android**: [Firebase 자격 증명 설정](/docs/ko/android-firebase-credentials)
* **iOS**: [p8 토큰(권장)](/docs/ko/ios-p8-token-based-connection-to-apns) 또는 [p12 인증서](/docs/ko/ios-p12-generate-certificates)
* **Amazon**: [API 키 생성](/docs/ko/generate-an-amazon-api-key)
* **Huawei**: [OneSignal 권한 부여](/docs/ko/authorize-onesignal-to-send-huawei-push)
자격 증명을 입력한 후 **Save & Continue**를 클릭합니다.
**앱 ID**가 최종 화면에 표시됩니다. 복사하고 저장하세요 — SDK를 초기화할 때 필요합니다. SDK 플랫폼을 선택한 다음 설정 가이드를 따릅니다.
***
## SDK 설정
### 1. SDK 추가
프로젝트에 `onesignal-cordova-plugin` 패키지를 추가합니다.
```shell Cordova theme={null}
cordova plugin add onesignal-cordova-plugin
```
```shell Ionic/Capacitor theme={null}
npm install onesignal-cordova-plugin
npx cap sync
```
### iOS 네이티브 의존성
`onesignal-cordova-plugin` 5.5.0부터 `cordova-ios` 8 이상을 사용하는 Cordova iOS 앱은 Swift Package Manager (SPM)로 OneSignal의 네이티브 iOS 의존성을 확인할 수 있습니다. 이전 Cordova iOS 앱은 계속 `OneSignalCordovaDependencies`를 통해 CocoaPods를 사용합니다.
이 Cordova 플러그인을 SPM과 함께 사용하는 Capacitor 앱은 Capacitor가 플러그인 루트의 `Package.swift`를 읽을 수 있도록 Capacitor 8.4.0 이상이 필요합니다. 새 Capacitor iOS 프로젝트의 경우 `npx cap add ios --packagemanager SPM`으로 네이티브 플랫폼을 생성한 다음, 플러그인을 설치한 후 `npx cap sync ios`를 실행하세요.
### 선택 사항: 위치 모듈 비활성화
`onesignal-cordova-plugin` 5.4.0부터 앱에서 `OneSignal.Location`을 사용하지 않는 경우 Android, iOS CocoaPods 및 iOS Swift Package Manager 빌드에서 OneSignal의 네이티브 위치 모듈을 제외할 수 있습니다.
플러그인을 설치하거나 네이티브 플랫폼을 동기화하기 전에 `ONESIGNAL_DISABLE_LOCATION=true`를 설정하세요. 값은 대소문자를 구분하지 않습니다. `1`로 설정할 수도 있습니다. iOS Swift Package Manager의 경우 `Package.swift`가 위치 비활성화 상태로 평가되도록 실제 Xcode 빌드 프로세스 중에도 플래그를 설정해 두세요.
```shell Cordova theme={null}
ONESIGNAL_DISABLE_LOCATION=true cordova plugin add onesignal-cordova-plugin
ONESIGNAL_DISABLE_LOCATION=true cordova platform add ios
ONESIGNAL_DISABLE_LOCATION=true cordova platform add android
```
```shell Capacitor theme={null}
ONESIGNAL_DISABLE_LOCATION=true npx cap sync ios
ONESIGNAL_DISABLE_LOCATION=true npx cap sync android
ONESIGNAL_DISABLE_LOCATION=true npx cap run ios --no-sync
```
```yaml GitHub Actions theme={null}
env:
ONESIGNAL_DISABLE_LOCATION: true
```
위치 모듈을 비활성화하면 `OneSignal.Location` 호출이 무시됩니다. `OneSignal.Location.isShared()`는 `false`로 확인됩니다.
#### 네이티브 의존성이 캐시된 후 변경 적용
환경 변수는 네이티브 의존성이 확인될 때 읽힙니다. 기존 프로젝트에서 변수를 변경하는 경우, 관련 네이티브 의존성 상태를 지우고 변수가 export된 shell에서 다시 확인하세요.
```shell Cordova theme={null}
cd platforms/ios
pod deintegrate
rm -rf Pods Podfile.lock
ONESIGNAL_DISABLE_LOCATION=true pod install
```
```shell Capacitor theme={null}
cd ios/App
pod deintegrate
rm -rf Pods Podfile.lock
ONESIGNAL_DISABLE_LOCATION=true pod install
```
```shell Swift Package Manager theme={null}
rm -rf ios/App/App.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
ONESIGNAL_DISABLE_LOCATION=true xcodebuild \
-resolvePackageDependencies \
-project ios/App/App.xcodeproj \
-derivedDataPath ios/App/build
ONESIGNAL_DISABLE_LOCATION=true xcodebuild \
-project ios/App/App.xcodeproj \
-scheme App \
-derivedDataPath ios/App/build
```
Xcode 또는 Android Studio를 사용할 때는 `ONESIGNAL_DISABLE_LOCATION`이 export된 터미널에서 IDE를 실행하세요. CI에서는 DerivedData, Swift Package Manager, CocoaPods 및 Gradle 캐시 키에 `ONESIGNAL_DISABLE_LOCATION` 값을 포함하세요.
### 2. SDK 초기화
프로젝트의 프레임워크(Cordova 및/또는 Ionic 또는 Ionic 및 Capacitor)에 따라 제공된 지침에 따라 OneSignal을 초기화합니다.
* **Angular**: `src/app/app.component.ts` 파일에서 제공된 메서드로 OneSignal을 초기화합니다.
* **React**: `src/App.tsx` 또는 `src/index.tsx` 파일에서 제공된 메서드로 OneSignal을 초기화합니다.
* **Vue**: `src/main.ts` 파일에서 제공된 메서드로 OneSignal을 초기화합니다.
`YOUR_APP_ID`를 OneSignal 대시보드 \*\*설정 > [키 및 ID](./keys-and-ids)\*\*에서 확인한 OneSignal 앱 ID로 교체하세요.
OneSignal 앱에 액세스할 수 없는 경우 [팀 멤버](./manage-team-members)에게 초대를 요청하세요.
```typescript Angular theme={null}
import OneSignal, { LogLevel } from 'onesignal-cordova-plugin';
@Component({
selector: 'app-root',
templateUrl: 'app.component.html',
styleUrls: ['app.component.scss'],
})
export class AppComponent {
constructor() {
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
}
}
```
```typescript React theme={null}
import { useEffect } from 'react';
import OneSignal, { LogLevel } from 'onesignal-cordova-plugin';
const App: React.FC = () => {
useEffect(() => {
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
}, []);
};
```
```typescript Vue theme={null}
import { createApp } from 'vue';
import App from './App.vue';
import router from './router';
import OneSignal, { LogLevel } from 'onesignal-cordova-plugin';
import { IonicVue } from '@ionic/vue';
const app = createApp(App)
.use(IonicVue)
.use(router);
router.isReady().then(() => {
app.mount('#app');
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
});
```
`capacitor.config.json` 또는 `capacitor.config.ts`를 열고 다음 코드를 추가하여 OneSignal이 iOS 푸시 알림을 처리할 수 있도록 합니다.
구독이 "APNS Delegate Never Fired" 오류로 실패하면 이 구성이 문제를 해결합니다.
```json json theme={null}
{
"ios": {
"handleApplicationNotifications": false
}
}
```
```typescript capacitor.config.ts theme={null}
const config: CapacitorConfig = {
// ... additional configuration
ios: {
// ... additional configuration
handleApplicationNotifications: false
}
};
```
`src/app/app.component.ts` 파일에서 제공된 메서드로 OneSignal을 초기화합니다.
`YOUR_APP_ID`를 OneSignal 대시보드 \*\*설정 > [키 및 ID](./keys-and-ids)\*\*에서 확인한 OneSignal 앱 ID로 교체하세요.
OneSignal 앱에 액세스할 수 없는 경우 [팀 멤버](./manage-team-members)에게 초대를 요청하세요.
```typescript typescript theme={null}
import OneSignal, { LogLevel } from 'onesignal-cordova-plugin';
constructor(platform: Platform) {
platform.ready().then(() => {
// Enable verbose logging for debugging (remove in production)
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
// Initialize with your OneSignal App ID
OneSignal.initialize("YOUR_APP_ID");
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
OneSignal.Notifications.requestPermission(false).then((accepted: boolean) => {
console.log("User accepted notifications: " + accepted);
});
});
}
```
`www/js/index.js` 파일에서 제공된 메서드로 OneSignal을 초기화합니다.
`YOUR_APP_ID`를 OneSignal 대시보드 \*\*설정 > [키 및 ID](./keys-and-ids)\*\*에서 확인한 OneSignal 앱 ID로 교체하세요.
OneSignal 앱에 액세스할 수 없는 경우 [팀 멤버](./manage-team-members)에게 초대를 요청하세요.
```javascript index.js theme={null}
document.addEventListener('deviceready', onDeviceReady, false);
function onDeviceReady() {
// Enable verbose logging for debugging (remove in production)
window.plugins.OneSignal.Debug.setLogLevel(6);
// Initialize with your OneSignal App ID
window.plugins.OneSignal.initialize('YOUR_APP_ID');
// Use this method to prompt for push notifications.
// We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
window.plugins.OneSignal.Notifications.requestPermission(false).then((accepted) => {
console.log("User accepted notifications: " + accepted);
});
}
```
***
## Android 설정
[Firebase 자격 증명](/docs/ko/android-firebase-credentials)을 사용하여 Android 플랫폼에 대해 OneSignal 앱이 구성되었는지 확인하세요.
앱 브랜딩과 일치하도록 [알림 아이콘](/docs/ko/notification-icons)을 설정합니다. 이 단계를 건너뛰면 푸시 알림에 기본 벨 아이콘이 표시됩니다.
**Android용 빌드**
이 시점에서 문제 없이 실제 Android 장치 또는 에뮬레이터에서 앱을 빌드하고 실행할 수 있어야 합니다.
Android 빌드가 작동하는지 확인한 후:
* 해당하는 경우 [iOS 설정](#ios-setup)을 계속합니다.
* 또는 [OneSignal SDK 통합 테스트](#testing-the-onesignal-sdk-integration)로 건너뜁니다.
***
## iOS setup
Make sure your OneSignal app is configured for the iOS platform using either the [p8 Token (Recommended)](/docs/en/ios-p8-token-based-connection-to-apns) or [p12 Certificate](/docs/en/ios-p12-generate-certificates).
Follow these steps to add push notifications to your iOS app, including support for [Badges](/docs/en/badges), [Confirmed receipt](/docs/en/confirmed-delivery), and images.
### 1. Add Push Notifications capability to app target
The [Push Notifications capability](https://developer.apple.com/documentation/UserNotifications/registering-your-app-with-apns#Enable-the-push-notifications-capability) allows your app to register a push token and receive notifications.
1. Open your app’s `.xcworkspace` file in Xcode.
2. Select **your app target > Signing & Capabilities**
3. Click **+ Capability** and add **Push Notifications** capability
### 2. Add Background Modes capability to app target
This enables your app to wake in the background when push notifications arrive.
1. Add [Background Modes](https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app) capability
2. Enable **Remote notifications**
### 3. Add app target to App Group
[App Groups](https://developer.apple.com/documentation/xcode/configuring-app-groups/#Create-App-Groups-for-all-other-platforms) allow data sharing between your app and the Notification Service Extension. Required for confirmed receipt and Badges.
1. Add **App Groups** capability
2. In the App Groups capability click **+**
3. Add a new container ID in format: `group.your_bundle_id.onesignal`
* Keep **group.** and **.onesignal** prefix and suffix. Replace **`your_bundle_id`** with your app's bundle identifier.
* For example, bundle identifier `com.onesignal.MyApp`, will have the container name `group.com.onesignal.MyApp.onesignal`.
Your App Group name must exactly match your bundle ID’s spelling and capitalization across all targets.
1. Open your **App Target** and **OneSignalNotificationServiceExtension Target's** `Info.plist`
2. Add a new property to the `Info.plist` for both targets:
* **Key:** `OneSignal_app_groups_key`
* **Value:** Your existing App Group name (e.g., `group.your-custom-group-id`)
```xml XML theme={null}
OneSignal_app_groups_key
group.your-custom-group-id
```
Make sure to update the `OneSignal_app_groups_key` in **both** the App Target **and** OneSignalNotificationServiceExtension Target's `Info.plist`!
### 4. Add Notification Service Extension
The [Notification Service Extension (NSE)](https://developer.apple.com/documentation/usernotifications/modifying-content-in-newly-delivered-notifications) enables rich notifications and confirmed receipt analytics.
1. In Xcode: **File > New > Target...**
2. Select **Notification Service Extension**, then **Next**.
3. Set the product name to `OneSignalNotificationServiceExtension` and press **Finish**.
4. Press **Don't Activate** on the Activate scheme prompt.
Set the OneSignalNotificationServiceExtension **Minimum Deployment Target** to match your main app (iOS 15+ recommended).
If you're using CocoaPods, set the deployment version in your Podfile as well.
### 5. Add NSE target to app group
Use the same App Group ID you added in step 3.
1. Go to **OneSignalNotificationServiceExtension > Signing & Capabilities**
2. Add **App Groups**
3. Add the exact same group ID
If you are using a custom App Group name and not `group.your_bundle_id.onesignal` then make sure to add your App Group ID to both the App Target and OneSignalNotificationServiceExtension Target's `Info.plist`! See [step 3](#3-add-app-target-to-app-group) for more information.
### 6. Update NSE code
1. Navigate to the **OneSignalNotificationServiceExtension** folder
2. Replace the contents of the `NotificationService.swift` or `NotificationService.m` file with the following:
```swift Swift theme={null}
import UserNotifications
import OneSignalExtension
class NotificationService: UNNotificationServiceExtension {
var contentHandler: ((UNNotificationContent) -> Void)?
var receivedRequest: UNNotificationRequest!
var bestAttemptContent: UNMutableNotificationContent?
// Note this extension only runs when `mutable_content` is set
// Setting an attachment or action buttons automatically sets the property to true
override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
self.receivedRequest = request
self.contentHandler = contentHandler
self.bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
if let bestAttemptContent = bestAttemptContent {
// DEBUGGING: Uncomment the 2 lines below to check this extension is executing
// print("Running NotificationServiceExtension")
// bestAttemptContent.body = "[Modified] " + bestAttemptContent.body
OneSignalExtension.didReceiveNotificationExtensionRequest(self.receivedRequest, with: bestAttemptContent, withContentHandler: self.contentHandler)
}
}
override func serviceExtensionTimeWillExpire() {
// 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 {
OneSignalExtension.serviceExtensionTimeWillExpireRequest(self.receivedRequest, with: self.bestAttemptContent)
contentHandler(bestAttemptContent)
}
}
}
```
```objectivec Objective-C theme={null}
#import
#import "NotificationService.h"
@interface NotificationService ()
@property (nonatomic, strong) void (^contentHandler)(UNNotificationContent *contentToDeliver);
@property (nonatomic, strong) UNNotificationRequest *receivedRequest;
@property (nonatomic, strong) UNMutableNotificationContent *bestAttemptContent;
@end
@implementation NotificationService
// Note, this extension only runs when mutable-content is set
// Setting an attachment or action buttons automatically adds this
- (void)didReceiveNotificationRequest:(UNNotificationRequest *)request withContentHandler:(void (^)(UNNotificationContent * _Nonnull))contentHandler {
self.receivedRequest = request;
self.contentHandler = contentHandler;
self.bestAttemptContent = [request.content mutableCopy];
// DEBUGGING: Uncomment the 2 lines below and comment out the one above to ensure this extension is executing
// NSLog(@"Running NotificationServiceExtension");
// self.bestAttemptContent.body = [@"[Modified] " stringByAppendingString:self.bestAttemptContent.body];
[OneSignalExtension didReceiveNotificationExtensionRequest:self.receivedRequest
withMutableNotificationContent:self.bestAttemptContent
withContentHandler:self.contentHandler];
}
- (void)serviceExtensionTimeWillExpire {
// Use this as an opportunity to deliver your "best attempt" at modified content, otherwise the original push payload will be used.
[OneSignalExtension serviceExtensionTimeWillExpireRequest:self.receivedRequest withMutableNotificationContent:self.bestAttemptContent];
self.contentHandler(self.bestAttemptContent);
}
@end
```
You should see an error because the OneSignal package is not installed. This will be resolved in the next step.
### 7. NSE 타겟에 OneSignal 추가
SDK가 iOS 의존성에 Swift Package Manager(SPM)를 사용하는 경우 이 단계를 건너뛸 수 있습니다. OneSignal 패키지는 이미 해결되어 모든 타겟에서 사용할 수 있습니다.
`ios/Podfile`을 업데이트하여 다음을 포함합니다:
```ruby Podfile theme={null}
target 'OneSignalNotificationServiceExtension' do
pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end
```
```ruby Example theme={null}
target 'MyApp' do
config = use_native_modules!
use_react_native!(
:path => config[:reactNativePath],
# An absolute path to your application root.
:app_path => "#{Pod::Config.instance.installation_root}/.."
)
post_install do |installer|
# https://github.com/facebook/react-native/blob/main/packages/react-native/scripts/react_native_pods.rb#L197-L202
react_native_post_install(
installer,
config[:reactNativePath],
:mac_catalyst_enabled => false,
# :ccache_enabled => true
)
end
end
target 'OneSignalNotificationServiceExtension' do
pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end
```
Open your project in the terminal and run:
```shell shell theme={null}
cd ios pod install cd ..
```
#### Common pod install errors
You may run into the following errors, here is how you can resolve them.
CocoaPods relies on the `xcodeproj` Ruby gem to read your Xcode project files. As of now, the latest `xcodeproj` release does not recognize object version 70, which was introduced by Xcode 16. So when CocoaPods tries to open your `.xcodeproj` file, it crashes with this error.
1. Close Xcode.
2. Navigate to your project's `ios/.xcodeproj/project.pbxproj` file.
3. Change this line: `objectVersion = 70;`
4. Replace it with: `objectVersion = 55;`
5. Save, close, and rerun `cd ios pod install cd ..`
### Build for iOS
You should now be able to build and run your app on a real iOS device or iOS simulator (16.2+).
#### Common iOS build errors
You may see this error when building with Xcode 15+, due to a default configuration change affecting cross platform systems.
1. Open your `.xcworkspace` folder in Xcode and navigate to **your app target > Build Phases**.
2. You should have a phase called **"Embed Foundation Extensions"** or **"Embed App Extensions"**.
3. Drag and move this build phase to *above* **"Run Script"**.
4. Build and run your app. The error should be resolved.
RuntimeError - `PBXGroup` attempted to initialize an object with unknown ISA `PBXFileSystemSynchronizedRootGroup` from attributes: `{"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>""}`
Fix:
1. Find the folder listed under "path" in the error
2. In Xcode project sidebar, right-click the folder
3. Select **Convert to Group**
After confirming that your iOS build works, continue with [Testing the OneSignal SDK integration](#testing-the-onesignal-sdk-integration).
***
## Testing the OneSignal SDK integration
This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.
If you are testing with an Android emulator, it should start with a cold boot.
1. Go to **Device Manager** in Android Studio.
2. Select your emulator device and click **Edit**.
3. Go to **Additional Settings** or **More**.
4. Set the **Boot option** to **Cold Boot**.
5. Save changes and restart the emulator.
### Check mobile subscriptions
The native push permission prompt should appear automatically if you added the `requestPermission` method during initialization.
Before accepting the prompt, check the OneSignal dashboard:
* Go to **Audience > Subscriptions**.
* You should see a new entry with the status "Never Subscribed".
The subscription's status should now show **Subscribed**.
You have successfully created a [mobile subscription](/docs/en/subscriptions).
Mobile subscriptions are created when users first open your app on a device or if they uninstall and reinstall your app on the same device.
### Set up test users
test users are helpful for testing a push notification before sending a message.
In the dashboard, next to the subscription, click the **Options (three dots)** button and select **Add to Test Users**.
Name the subscription so you can easily identify your device later in the **test users tab**.
Go to **Audience > Segments > New Segment**.
Name the segment `Test Users` (the name is important because it will be used later).
You have successfully created a segment of test users.
We can now test sending messages to this individual device and groups of test users.
### Send test push via API
In your OneSignal dashboard, go to **Settings > [Keys & IDs](/docs/en/keys-and-ids)**.
Replace `YOUR_APP_API_KEY` and `YOUR_APP_ID` in the code below with your actual keys. This code uses the `Test Users` segment we created earlier.
```curl theme={null}
curl -X \
POST --url 'https://api.onesignal.com/notifications' \
--header 'content-type: application/json; charset=utf-8' \
--header 'authorization: Key YOUR_APP_API_KEY' \
--data \
'{
"app_id": "YOUR_APP_ID",
"target_channel": "push",
"name": "Testing basic setup",
"headings": {
"en": "👋"
},
"contents": {
"en": "Hello world!"
},
"included_segments": [
"Test Users"
],
"ios_attachments": {
"onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
},
"big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'
```
Run the code in your terminal.
If all setup steps were completed successfully, the test users should receive a notification with an image included:
Images will appear small in the collapsed notification view. Expand the notification to see the full image.
In your dashboard, go to **Delivery > Sent Messages**, then click the message to view stats.
You should see the **confirmed** stat, meaning the device received the push.
You have successfully sent a notification via our API to a segment.
* No image received? Your [Notification Service Extension](#ios-setup) might be missing.
* No confirmed receipt? Review the troubleshooting guide [here](/docs/en/confirmed-delivery#troubleshooting-confirmed-delivery).
* Having issues? Copy-paste the api request and a log from start to finish of app launch into a `.txt` file. Then share both with `support@onesignal.com`.
### Send an in-app message
[In-app messages](/docs/en/in-app-messages-setup) let you communicate with users while they are using your app.
This is because users must meet the in-app audience criteria *before* a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on [how in-app messages are displayed](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* In your OneSignal dashboard, navigate to **Messages > In-App > New In-App**.
* Find and select the **Welcome** message.
* Set your Audience as the **Test Users** segment we used previously.
Under **Schedule > How often do you want to show this message?** select **Every time trigger conditions are satisfied**.
Click **Make Message Live** so it is available to your Test Users each time they open the app.
After the in-app message is live, open your app. You should see it display:
Not seeing the message?
* Start a new session
* You must close or background the app for at least 30 seconds before reopening. This ensures a new session is started.
* For more, see [how in-app messages are displayed](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* Still in the `Test Users` segment?
* If you reinstalled or switched devices, re-add the device to [Test Users](#set-up-test-users) and confirm it's part of the Test Users segment.
* Having issues?
* Follow [Getting a Debug Log](/docs/en/capturing-a-debug-log) while reproducing the steps above. This will generate additional logging that you can share with `support@onesignal.com` and we will help investigate what's going on.
You have successfully setup the OneSignal SDK and learned important concepts like:
* Gathering [Subscriptions](/docs/en/subscriptions), setting [Test Users](/docs/en/find-set-test-subscriptions), and creating [Segments](/docs/en/segmentation).
* Sending [Push](/docs/en/push) with images and [Confirmed receipt](/docs/en/confirmed-delivery) using Segments and our [Create message](/reference/create-message) API.
* Sending [In-app messages](/docs/en/in-app-messages-setup).
Continue with this guide to identify users in your app and setup additional features.
***
## User identification
Previously, we demonstrated how to create mobile [Subscriptions](/docs/en/subscriptions). Now we'll expand to identifying [Users](/docs/en/users) across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We'll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.
### Assign External ID
Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend's user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for [Integrations](/docs/en/integrations)).
Set the External ID with our SDK's [`login` method](/docs/en/mobile-sdk-reference#login-external-id) each time they are identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).
As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.
Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.
### Add Tags
[Tags](/docs/en/add-user-data-tags) are key-value pairs of string data you can use to store user properties (like `username`, `role`, or preferences) and events (like `purchase_date`, `game_level`, or user interactions). Tags power advanced [Message Personalization](/docs/en/message-personalization) and [Segmentation](/docs/en/segmentation) allowing for more advanced use cases.
Set tags with our SDK [`addTag` and `addTags` methods](/docs/en/mobile-sdk-reference#data-tags) as events occur in your app.
In this example, the user reached level 6 identifiable by the tag called `current_level` set to a value of `6`.
We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:
### Add email and/or SMS subscriptions
Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions.
* Use the [`addEmail` method](/docs/en/mobile-sdk-reference#addemail-%2C-removeemail) to create email subscriptions.
* Use the [`addSms` method](/docs/en/mobile-sdk-reference#addsms-%2C-removesms) to create SMS subscriptions.
If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates.
You can view unified users via **Audience > Users** in the dashboard or with the [View user API](/reference/view-user).
Best practices for multi-channel communication
* Obtain explicit consent before adding email or SMS subscriptions.
* Explain the benefits of each communication channel to users.
* Provide channel preferences so users can select which channels they prefer.
***
### Privacy & user consent
To control when OneSignal collects user data, use the SDK's consent gating methods:
* [`setConsentRequired(true)`](/docs/en/mobile-sdk-reference#setconsentrequired): Prevents data collection until consent is given.
* [`setConsentGiven(true)`](/docs/en/mobile-sdk-reference#setconsentgiven): Enables data collection once consent is granted.
See our Privacy & security docs for more on:
* [Data collected by the SDK](/docs/en/data-collected-by-the-onesignal-sdk)
* [Handling personal data](/docs/en/handling-personal-data)
***
## Prompt for push permissions
Instead of calling `requestPermission()` immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission.
For best practices and implementation details, see our [Prompt for push permissions](/docs/en/prompt-for-push-permissions) guide.
***
## Listen to push, user, and in-app events
Use SDK listeners to react to user actions and state changes.
The SDK provides several event listeners for you to hook into. See our [SDK reference guide](/docs/en/mobile-sdk-reference) for more details.
### Push notification events
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-push): Detect when a notification is tapped. Helpful for [Deep Linking](/docs/en/deep-linking).
* [`addForegroundLifecycleListener()`](/docs/en/mobile-sdk-reference#addforegroundlifecyclelistener-push): Control how notifications behave in foreground.
For full customization, see [Mobile Service Extensions](/docs/en/service-extensions).
### User state changes
* [`addObserver()` for user state](/docs/en/mobile-sdk-reference#addobserver-user-state): Detect when the External ID is set.
* [`addPermissionObserver()`](/docs/en/mobile-sdk-reference#addpermissionobserver-push): Track the user's specific interaction with the native push permission prompt.
* [`addObserver()` for push subscription](/docs/en/mobile-sdk-reference#addobserver-push-subscription-changes): Track when the push subscription status changes.
### In-app message events
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app): Handle in-app click actions. Ideal for deep linking or tracking events.
* [`addLifecycleListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).
***
## Advanced setup & capabilities
Explore more capabilities to enhance your integration:
* [🔁 Migrating to OneSignal from another service](/docs/en/migrating-to-onesignal)
* [🌍 Location tracking](/docs/en/mobile-sdk-reference#location)
* [🔗 Deep Linking](/docs/en/deep-linking)
* [🔌 Integrations](/docs/en/integrations)
* [🧩 Mobile Service Extensions](/docs/en/service-extensions)
* [🛎️ Action buttons](/docs/en/action-buttons)
* [🌐 Multi-language messaging](/docs/en/multi-language-messaging)
* [🛡️ Identity Verification](/docs/en/identity-verification)
* [📊 Custom Outcomes](/docs/en/custom-outcomes)
* [📲 Live Activities](/docs/en/live-activities)
### Mobile SDK setup & reference
Make sure you've enabled all key features by reviewing the [Mobile push setup](/docs/en/mobile-push-setup) guide.
For full details on available methods and configuration options, visit the [Mobile SDK reference](/docs/en/mobile-sdk-reference).
Congratulations! You've successfully completed the Mobile SDK setup guide.
***
도움이 필요하신가요?
지원 팀과 채팅하거나 `support@onesignal.com`으로 이메일을 보내주세요.
다음을 포함해 주세요:
* 발생한 문제의 세부 정보 및 재현 단계(가능한 경우)
* OneSignal 앱 ID
* External ID 또는 Subscription ID(해당하는 경우)
* OneSignal 대시보드에서 테스트한 메시지의 URL(해당하는 경우)
* 관련 [로그 또는 오류 메시지](/docs/ko/capturing-a-debug-log)
기꺼이 도와드리겠습니다!
***