React Native SDK 설정

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.

​

요구 사항

• bare React Native 앱입니다. 관리형 Expo 앱의 경우 Expo SDK 설정을 사용하세요.
• React Native 0.79+, New Architecture 활성화 필요
• 구성된 OneSignal 앱 및 플랫폼

• Xcode 14+가 설치된 macOS (설정 지침은 Xcode 16.2 사용)
• iOS 12+, iPadOS 12+ 장치 또는 iOS 16.2+를 실행하는 Xcode 시뮬레이터
• CocoaPods 1.16.2+

• Google Play Store(서비스)가 설치된 Android 7.0+ 장치 또는 에뮬레이터

​

OneSignal 앱 및 플랫폼 구성

단계별 설정 지침

1

앱 만들기 또는 선택

New App/Website를 클릭하여 새 앱을 만들거나 설정 > 푸시 및 인앱에서 기존 앱에 플랫폼을 추가합니다. 구성하려는 플랫폼을 선택하고 Next: Configure Your Platform을 클릭합니다.

2

플랫폼 자격 증명 구성

플랫폼에 대한 자격 증명을 입력합니다:

• Android: Firebase 자격 증명 설정
• iOS: p8 토큰(권장) 또는 p12 인증서
• Amazon: API 키 생성
• Huawei: OneSignal 권한 부여

자격 증명을 입력한 후 Save & Continue를 클릭합니다.

3

앱 ID를 저장하고 SDK 설치

앱 ID가 최종 화면에 표시됩니다. 복사하고 저장하세요 — SDK를 초기화할 때 필요합니다. SDK 플랫폼을 선택한 다음 설정 가이드를 따릅니다.

​

SDK 설정

​

1. SDK 추가

  npm install --save react-native-onesignal

​

2. SDK 초기화

import React, {useEffect} from 'react';
// Include the OneSignal package
import {OneSignal, LogLevel} from 'react-native-onesignal';

function App(): React.JSX.Element {
  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);
  }, []);

  return (
    // Your main app UI goes here
  );
}

​

Android 설정

​

iOS setup

​

1. Add Push Notifications capability to app target

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

1. Add Background Modes capability
2. Enable Remote notifications

​

3. Add app target to App Group

• If you do NOT have an App Group configured
• If you DO have an App Group

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

<key>OneSignal_app_groups_key</key>
<string>group.your-custom-group-id</string>

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

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.

​

5. Add NSE target to app group

1. Go to OneSignalNotificationServiceExtension > Signing & Capabilities
2. Add App Groups
3. Add the exact same group ID

​

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:

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)
        }
    }
}

​

7. NSE 타겟에 OneSignal 추가

target 'OneSignalNotificationServiceExtension' do
  pod 'OneSignalXCFramework', '>= 5.0.0', '< 6.0'
end

cd ios pod install cd .. 

​

Common pod install errors

​

Build for iOS

​

Common iOS build errors

Cycle Inside... building could produce unreliable results.

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.

PBXGroup Error

RuntimeError - PBXGroup attempted to initialize an object with unknown ISA PBXFileSystemSynchronizedRootGroup from attributes: {"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>"<group>"}

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

​

Testing the OneSignal SDK integration

​

Check mobile subscriptions

1

Launch your app on a test device.

The native push permission prompt should appear automatically if you added the requestPermission method during initialization.

2

Check your OneSignal dashboard

Before accepting the prompt, check the OneSignal dashboard:

• Go to Audience > Subscriptions.
• You should see a new entry with the status “Never Subscribed”.

3

Return to the app and tap Allow on the prompt.

4

Refresh the OneSignal dashboard Subscription's page.

The subscription’s status should now show Subscribed.

You have successfully created a mobile subscription. 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

1

Add to Test Users.

In the dashboard, next to the subscription, click the Options (three dots) button and select Add to Test Users.

2

Name your subscription.

Name the subscription so you can easily identify your device later in the test users tab.

3

Create a test users segment.

Go to Audience > Segments > New Segment.

4

Name the segment.

Name the segment Test Users (the name is important because it will be used later).

5

Add the Test Users filter and click Create Segment.

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

1

Get your App API Key and App ID.

In your OneSignal dashboard, go to Settings > Keys & IDs.

2

Update the provided code.

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 -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"
}'

3

Run the code.

Run the code in your terminal.

4

Check images and confirmed delivery.

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.

5

Check for confirmed delivery.

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 might be missing.
• No confirmed delivery? Review the troubleshooting guide here.
• 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

1

Close or background your app on the device.

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.

2

Create an in-app message.

• 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.

3

Customize the message content if desired.

4

Set Trigger to 'On app open'.

5

Schedule frequency.

Under Schedule > How often do you want to show this message? select Every time trigger conditions are satisfied.

6

Make message live.

Click Make Message Live so it is available to your Test Users each time they open the app.

7

Open the app and see the message.

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.
• Still in the Test Users segment?
  • If you reinstalled or switched devices, re-add the device to Test Users and confirm it’s part of the Test Users segment.
• Having issues?
  • Follow Getting 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.

​

User identification

​

Assign External ID

​

Add Tags

​

Add email and/or SMS subscriptions

• Use the addEmail method to create email subscriptions.
• Use the addSms method to create SMS subscriptions.

​

Privacy & user consent

• setConsentRequired(true): Prevents data collection until consent is given.
• setConsentGiven(true): Enables data collection once consent is granted.

• Data collected by the SDK
• Handling personal data

​

Prompt for push permissions

​

Listen to push, user, and in-app events

​

Push notification events

• addClickListener(): Detect when a notification is tapped. Helpful for Deep Linking.
• addForegroundLifecycleListener(): Control how notifications behave in foreground.

​

User state changes

• addObserver() for user state: Detect when the External ID is set.
• addPermissionObserver(): Track the user’s specific interaction with the native push permission prompt.
• addObserver() for push subscription: Track when the push subscription status changes.

​

In-app message events

• addClickListener(): Handle in-app click actions. Ideal for deep linking or tracking events.
• addLifecycleListener(): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).

​

Advanced setup & capabilities

• 🔁 Migrating to OneSignal from another service
• 🌍 Location tracking
• 🔗 Deep Linking
• 🔌 Integrations
• 🧩 Mobile Service Extensions
• 🛎️ Action buttons
• 🌐 Multi-language messaging
• 🛡️ Identity Verification
• 📊 Custom Outcomes
• 📲 Live Activities

​

Mobile SDK setup & reference

​

개인정보 보호 및 사용자 동의

// OneSignal.initialize() 전에 호출
OneSignal.setConsentRequired(true);
OneSignal.initialize('YOUR_APP_ID');

// 나중에 사용자가 동의를 부여한 후(예: 동의 대화상자를 통해)
OneSignal.setConsentGiven(true);

​

문제 해결