> ## 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
;
};
## 概要
このガイドでは、OneSignalプッシュ通知をIonic、Capacitor、またはCordovaアプリケーションに統合する方法について説明します。インストールから設定、サービスワーカー管理まですべてをカバーしています。
Capacitorアプリを開発していますか？代わりに[Capacitor SDKセットアップ](./capacitor-sdk-setup)ガイドの使用を強く推奨します。このCordovaセットアップは、既存のCordovaコードとの互換性のためにCapacitorプロジェクトで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 Store（サービス）がインストールされたAndroid 7.0以降のデバイスまたはエミュレーター
アプリ名にスペースを含めないでください（ビルドの問題を避けるために、「My App」ではなく「MyApp」などのように）
### Configure your OneSignal app and platform
Configure your OneSignal app with the platforms you support — Apple (APNs), Google (FCM), Huawei (HMS), and/or Amazon (ADM).
If your organization already has a OneSignal account, [ask to be invited](/docs/en/manage-team-members) to the Organization. Otherwise, [sign up for a free account](https://onesignal.com) to get started.
Create a new app by clicking **New App/Website**, or add a platform to an existing app in **Settings > Push & In-App**. Select the platform(s) you want to configure and click **Next: Configure Your Platform**.
Enter the credentials for your platform:
* **Android**: [Set up Firebase credentials](/docs/en/android-firebase-credentials)
* **iOS**: [p8 token (recommended)](/docs/en/ios-p8-token-based-connection-to-apns) or [p12 certificate](/docs/en/ios-p12-generate-certificates)
* **Amazon**: [Generate API key](/docs/en/generate-an-amazon-api-key)
* **Huawei**: [Authorize OneSignal](/docs/en/authorize-onesignal-to-send-huawei-push)
Click **Save & Continue** after entering your credentials.
Your **App ID** is displayed on the final screen. Copy and save it — you need it when initializing the SDK. Select your SDK platform, then follow the setup guide.
***
## 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アプリは、OneSignalのネイティブiOS依存関係をSwift Package Manager (SPM)で解決できます。古いCordova iOSアプリは、引き続き`OneSignalCordovaDependencies`を通じてCocoaPodsを使用します。
このCordovaプラグインをSPMで使用するCapacitorアプリには、プラグインのルート`Package.swift`をCapacitorが読み取れるように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` に解決されます。
#### ネイティブ依存関係がキャッシュされた後に変更を適用する
環境変数はネイティブ依存関係が解決されるときに読み取られます。既存のプロジェクトで変数を変更する場合は、関連するネイティブ依存関係の状態をクリアし、変数がエクスポートされているシェルで再解決してください。
```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` がエクスポートされているターミナルから 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を初期化します。
OneSignalダッシュボードの\*\*設定 > [キーとID](./keys-and-ids)\*\*にあるOneSignalアプリIDで`YOUR_APP_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を初期化します。
OneSignalダッシュボードの\*\*設定 > [キーとID](./keys-and-ids)\*\*にあるOneSignalアプリIDで`YOUR_APP_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を初期化します。
OneSignalダッシュボードの\*\*設定 > [キーとID](./keys-and-ids)\*\*にあるOneSignalアプリIDで`YOUR_APP_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 setup
Make sure your OneSignal app is configured for the Android platform using your [Firebase credentials](/docs/en/android-firebase-credentials).
Set up your [notification icons](/docs/en/notification-icons) to match your app’s branding. If this step is skipped, a default bell icon will display for your push notifications.
**Build for Android**
At this point, you should be able to build and run your app on a physical Android device or emulator without issues.
After confirming that your Android build works:
* Continue with the [iOS setup](#ios-setup), if applicable.
* Or jump ahead to [Testing the OneSignal SDK integration](#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. Add OneSignal to the NSE target
If your SDK uses Swift Package Manager (SPM) for iOS dependencies, you can skip this step. The OneSignal package is already resolved and available to all targets.
Update your `ios/Podfile` to include:
```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
1. Delete your Podfile.lock
2. Delete your Pods folder
3. Delete your .xcworkspace
4. Pod install
5. Cmd + Shift + K to Clean the build and then retry building
If these steps do not resolve the error, build directly from the Xcode, then find the build error in the report navigator pictured below.
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.
***
Need help?
Chat with our Support team or email `support@onesignal.com`
Please include:
* Details of the issue you're experiencing and steps to reproduce if available
* Your OneSignal App ID
* The External ID or Subscription ID if applicable
* The URL to the message you tested in the OneSignal Dashboard if applicable
* Any relevant [logs or error messages](/docs/en/capturing-a-debug-log)
We're happy to help!
***