메인 콘텐츠로 건너뛰기

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.

OneSignal은 기기 중심 모델(Player ID)에서 사용자 중심 모델(OneSignal ID)로 업데이트되었습니다. 마이그레이션 가이드는 사용자 모델 마이그레이션 가이드를 참조하세요.레거시 기기 중심 구현에 대한 문서는 버전 9를 참조하세요.
이 페이지는 OneSignal의 Player 모델과 User 모델 SDK 간의 메서드 및 속성 이름을 매핑합니다. 익숙함을 위해 원래 Player 모델 클라이언트 SDK 참조의 레이아웃을 반영합니다. Swift 예제는 API 변경 사항을 보여주지만 항상 완전한 작업 샘플은 아닙니다. 다른 언어의 예제 및 전체 구현 세부 정보는 연결된 문서를 참조하세요.

OneSignal 초기화

initWithLaunchOptions()

Player 모델 참조
OneSignal.initWithLaunchOptions(launchOptions)
OneSignal.setAppId("ONESIGNAL_APP_ID")
User 모델 참조
OneSignal.initialize("YOUR_ONESIGNAL_APP_ID", withLaunchOptions: launchOptions)

디버깅

setLogLevel()

Player 모델 참조
OneSignal.setLogLevel(.LL_VERBOSE, visualLevel: .LL_NONE)
User 모델 참조
OneSignal.Debug.setLogLevel(.LL_VERBOSE)

외부 사용자 ID

setExternalId()

Player 모델 참조
OneSignal.setExternalId("EXTERNAL_USER_ID")
User 모델 참조
OneSignal.login("EXTERNAL_USER_ID")

removeExternalUserId()

Player 모델 참조
OneSignal.removeExternalUserId({ results in ... })
User 모델 참조
OneSignal.logout()

태그

sendTag()

Player 모델 참조
OneSignal.sendTag("key", value: "value")
User 모델 참조
OneSignal.User.addTag(key: "key", value: "value")

sendTags()

OneSignal.sendTags(["key1": "value1", "key2": "value2"])
OneSignal.User.addTags(["key1": "value1", "key2": "value2"])

getTags()

OneSignal.getTags({ tags in ..., onFailure: { error in ... })
let tags = OneSignal.User.getTags()

deleteTag()

OneSignal.deleteTag("key")
OneSignal.User.removeTag("key")

deleteTags()

OneSignal.deleteTags(["key1", "key2"])
OneSignal.User.removeTags(["key1", "key2"])

사용자 데이터

notificationPermissionStatus

OneSignal.getDeviceState().notificationPermissionStatus
OneSignal.Notifications.permissionNative

userId

OneSignal.getDeviceState().userId
OneSignal.User.pushSubscription.id

hasNotificationPermission() / areNotificationsEnabled

OneSignal.getDeviceState().areNotificationsEnabled()
OneSignal.Notifications.permission

pushToken

OneSignal.getDeviceState().pushToken
OneSignal.User.pushSubscription.token

hasNotificationPermission

OneSignal.getDeviceState().hasNotificationPermission
OneSignal.User.pushSubscription.optedIn

isSubscribed [제거됨]

OneSignal.getDeviceState().isSubscribed
User 모델: N/A

isPushDisabled [제거됨]

OneSignal.getDeviceState().isPushDisabled
User 모델: N/A

setLanguage()

OneSignal.setLanguage("es")
OneSignal.User.setLanguage("en")

개인정보 보호

setRequiresUserPrivacyConsent()

OneSignal.setRequiresUserPrivacyConsent(true)
OneSignal.setConsentRequired(true)

consentGranted()

OneSignal.consentGranted(true)
OneSignal.setConsentGiven(true)

위치

setLocationShared()

OneSignal.setLocationShared(false)
OneSignal.Location.isShared = false

isLocationShared()

OneSignal.isLocationShared()
OneSignal.Location.isShared

promptLocation()

OneSignal.promptLocation()
OneSignal.Location.requestPermission()

구독 옵저버

addSubscriptionObserver()

OneSignal.addSubscriptionObserver(subscriptionObserver)
OneSignal.User.pushSubscription.addObserver(pushSubscriptionObserver)

removeSubscriptionObserver()

OneSignal.removeSubscriptionObserver(subscriptionObserver)
OneSignal.User.pushSubscription.removeObserver(pushSubscriptionObserver)

푸시 알림

promptForPushNotifications()

OneSignal.promptForPushNotifications()
OneSignal.Notifications.requestPermission()

postNotification() [제거됨]

OneSignal.postNotification()
User 모델: N/A

clearOneSignalNotifications()

OneSignal.clearOneSignalNotifications()
OneSignal.Notifications.clearAll()

disablePush()

OneSignal.disablePush(true)
OneSignal.User.pushSubscription.optOut()

unsubscribeWhenNotificationsAreDisabled() [제거됨]

OneSignal.unsubscribeWhenNotificationsAreDisabled(false)
User 모델: N/A

setLaunchURLsInApp() [제거됨]

OneSignal.setLaunchURLsInApp(true)
User 모델: N/A

registerForProvisionalAuthorization()

OneSignal.registerForProvisionalAuthorization({userResponse in ...})
OneSignal.Notifications.registerForProvisionalAuthorization({ userReponse in ... })

setNotificationWillShowInForegroundHandler()

OneSignal.setNotificationWillShowInForegroundHandler(foregroundHandler)
OneSignal.Notifications.addForegroundLifecycleListener(notificationLifecyleHandler)

setNotificationOpenedHandler()

OneSignal.setNotificationOpenedHandler(notificationOpenHandler)
OneSignal.Notifications.addClickListener(notificationClickListener)

addPermissionObserver()

OneSignal.addPermissionObserver(self as OSPermissionObserver)
OneSignal.Notifications.addPermissionObserver(notificationPermissionObserver)

removePermissionObserver()

OneSignal.removePermissionObserver()
OneSignal.Notifications.removePermissionObserver(notificationPermissionObserver)

Live Activities

enterLiveActivity()

OneSignal.enterLiveActivity("my_activity_id", withToken: myToken)
OneSignal.LiveActivities.enter("my_activity_id", withToken: "TOKEN")

exit()

OneSignal.exitLiveActivity("my_activity_id")
OneSignal.LiveActivities.exit("my_activity_id")

인앱 메시지

addTrigger()

OneSignal.addTrigger("prompt_ios", withValue: "true");
OneSignal.InAppMessages.addTrigger("KEY", withValue: "VALUE")

addTriggers()

OneSignal.addTriggers(["trigger_key_1": "1", "trigger_key_2": "some_other_value"])
OneSignal.InAppMessages.addTriggers(["trigger_key_1": "1", "trigger_key_2": "some_other_value"])

removeTriggerForKey()

OneSignal.removeTriggerForKey("trigger_key_1");
OneSignal.InAppMessages.removeTrigger("trigger_key_1")

removeTriggerForKeys()

OneSignal.removeTriggerForKeys(["trigger_key_1", "trigger_key_2"])
OneSignal.InAppMessages.removeTriggers(["trigger_key_1", "trigger_key_2"])

getTriggerValueForKey() [제거됨]

OneSignal.getTriggerValueForKey("trigger_key");
User 모델: N/A

inAppMessagesArePaused

OneSignal.inAppMessagesArePaused = true
OneSignal.InAppMessages.paused = true

setInAppMessageLifecycleHandler()

OneSignal.setInAppMessageLifecycleHandler(handler)
OneSignal.InAppMessages.addLifecycleListener(listener)

setInAppMessageClickHandler()

OneSignal.setInAppMessageClickHandler(clickHandler)
OneSignal.InAppMessages.addClickListener(clickListener)

이메일

setEmail()

User 모델 문서
OneSignal.setEmail("email@example.com")
OneSignal.User.addEmail("email@example.com")

logoutEmail()

OneSignal.logoutEmail()
OneSignal.User.removeEmail("email@example.com")

SMS

setSMSNumber()

OneSignal.setSMSNumber("+11234567890")
OneSignal.User.addSms("+11234567890")

logoutSMSNumber()

OneSignal.logoutSMSNumber()
OneSignal.User.removeSms("+11234567890")

addSMSSubscriptionObserver() [제거됨]

OneSignal.add(subscriptionObserver)
User 모델: N/A

getSMSId() [제거됨]

OneSignal.Default.SMSSubscriptionState.smsUserId
User 모델: N/A

Outcomes

sendOutcome()

OneSignal.sendOutcome("Purchase")
OneSignal.Session.addOutcome("Purchase")

sendOutcomeWithValue()

OneSignal.sendOutcomeWithValue(withValue: "Purchase", value: 18.76)
OneSignal.Session.addOutcome("Purchase", 18.76)

sendUniqueOutcome()

OneSignal.sendUniqueOutcome("Swipe")
OneSignal.Session.addUniqueOutcome("Swipe")