Compare method and property names between OneSignal’s legacy Player Model (v3 & v4) and the modern User Model (v5+), with side-by-side Swift code examples for easier migration.
OneSignal is transitioning from a device-centric model (Player ID) to a user-centric model (OneSignal ID). For migration guidance, refer to the User Model Migration Guide.
For documentation on legacy device-centric implementations, see Version 9.
This page maps method and property names between OneSignal’s Player Model and User Model SDKs. It mirrors the layout of the original Player Model Client SDK Reference for familiarity. Swift examples illustrate the API changes, but these are not always complete working samples. Refer to the linked documentation for examples in other languages and full implementation details.
initWithLaunchOptions()
Player Model Reference
User Model Reference
setLogLevel()
Player Model Reference
User Model Reference
setExternalId()
Player Model Reference
User Model Reference
removeExternalUserId()
Player Model Reference
User Model Reference
sendTag()
Player Model Reference
User Model Reference
sendTags()
getTags()
deleteTag()
deleteTags()
notificationPermissionStatus
userId
hasNotificationPermission()
/ areNotificationsEnabled
pushToken
hasNotificationPermission
isSubscribed
[Dropped]User Model: N/A
isPushDisabled
[Dropped]User Model: N/A
setLanguage()
setRequiresUserPrivacyConsent()
consentGranted()
setLocationShared()
isLocationShared()
promptLocation()
addSubscriptionObserver()
removeSubscriptionObserver()
promptForPushNotifications()
postNotification()
[Dropped]User Model: N/A
clearOneSignalNotifications()
disablePush()
unsubscribeWhenNotificationsAreDisabled()
[Dropped]User Model: N/A
setLaunchURLsInApp()
[Dropped]User Model: N/A
registerForProvisionalAuthorization()
setNotificationWillShowInForegroundHandler()
setNotificationOpenedHandler()
addPermissionObserver()
removePermissionObserver()
enterLiveActivity()
exit()
addTrigger()
addTriggers()
removeTriggerForKey()
removeTriggerForKeys()
getTriggerValueForKey()
[Dropped]User Model: N/A
inAppMessagesArePaused
setInAppMessageLifecycleHandler()
setInAppMessageClickHandler()
setEmail()
User Model doc
logoutEmail()
setSMSNumber()
logoutSMSNumber()
addSMSSubscriptionObserver()
[Dropped]User Model: N/A
getSMSId()
[Dropped]User Model: N/A
sendOutcome()
sendOutcomeWithValue()
sendUniqueOutcome()
Compare method and property names between OneSignal’s legacy Player Model (v3 & v4) and the modern User Model (v5+), with side-by-side Swift code examples for easier migration.
OneSignal is transitioning from a device-centric model (Player ID) to a user-centric model (OneSignal ID). For migration guidance, refer to the User Model Migration Guide.
For documentation on legacy device-centric implementations, see Version 9.
This page maps method and property names between OneSignal’s Player Model and User Model SDKs. It mirrors the layout of the original Player Model Client SDK Reference for familiarity. Swift examples illustrate the API changes, but these are not always complete working samples. Refer to the linked documentation for examples in other languages and full implementation details.
initWithLaunchOptions()
Player Model Reference
User Model Reference
setLogLevel()
Player Model Reference
User Model Reference
setExternalId()
Player Model Reference
User Model Reference
removeExternalUserId()
Player Model Reference
User Model Reference
sendTag()
Player Model Reference
User Model Reference
sendTags()
getTags()
deleteTag()
deleteTags()
notificationPermissionStatus
userId
hasNotificationPermission()
/ areNotificationsEnabled
pushToken
hasNotificationPermission
isSubscribed
[Dropped]User Model: N/A
isPushDisabled
[Dropped]User Model: N/A
setLanguage()
setRequiresUserPrivacyConsent()
consentGranted()
setLocationShared()
isLocationShared()
promptLocation()
addSubscriptionObserver()
removeSubscriptionObserver()
promptForPushNotifications()
postNotification()
[Dropped]User Model: N/A
clearOneSignalNotifications()
disablePush()
unsubscribeWhenNotificationsAreDisabled()
[Dropped]User Model: N/A
setLaunchURLsInApp()
[Dropped]User Model: N/A
registerForProvisionalAuthorization()
setNotificationWillShowInForegroundHandler()
setNotificationOpenedHandler()
addPermissionObserver()
removePermissionObserver()
enterLiveActivity()
exit()
addTrigger()
addTriggers()
removeTriggerForKey()
removeTriggerForKeys()
getTriggerValueForKey()
[Dropped]User Model: N/A
inAppMessagesArePaused
setInAppMessageLifecycleHandler()
setInAppMessageClickHandler()
setEmail()
User Model doc
logoutEmail()
setSMSNumber()
logoutSMSNumber()
addSMSSubscriptionObserver()
[Dropped]User Model: N/A
getSMSId()
[Dropped]User Model: N/A
sendOutcome()
sendOutcomeWithValue()
sendUniqueOutcome()